From d6a9447352ffcff9f15cb58263f72775b099466f Mon Sep 17 00:00:00 2001
From: Connor <olivecon@oregonstate.edu>
Date: Tue, 11 Mar 2025 15:30:19 -0700
Subject: [PATCH 1/2] Fix pandas.util.hash_pandas_object docstring
- Add parameter description to obj parameter
- Correct the Returns section
- Change the type line to correctly callout 'Series' type
- Update return description to describe the type contained in
the Series
- Add See Also section
Also remove pandas.Timestamp.resolution from code_checks.sh because it
is not a function anymore.
---
ci/code_checks.sh | 4 +---
pandas/core/util/hashing.py | 10 ++++++++--
2 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
index 6ce43725fecc9..62410632d4faa 100755
--- a/ci/code_checks.sh
+++ b/ci/code_checks.sh
@@ -77,7 +77,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timedelta.resolution PR02" \
-i "pandas.Timestamp.max PR02" \
-i "pandas.Timestamp.min PR02" \
- -i "pandas.Timestamp.resolution PR02" \
-i "pandas.Timestamp.tzinfo GL08" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
@@ -274,8 +273,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.YearEnd.is_on_offset GL08" \
-i "pandas.tseries.offsets.YearEnd.month GL08" \
-i "pandas.tseries.offsets.YearEnd.n GL08" \
- -i "pandas.tseries.offsets.YearEnd.normalize GL08" \
- -i "pandas.util.hash_pandas_object PR07,SA01" # There should be no backslash in the final line, please keep this comment in the last ignored function
+ -i "pandas.tseries.offsets.YearEnd.normalize GL08" # There should be no backslash in the final line, please keep this comment in the last ignored function
RET=$(($RET + $?)) ; echo $MSG "DONE"
diff --git a/pandas/core/util/hashing.py b/pandas/core/util/hashing.py
index e120e69dc27cf..931e7e32e07a0 100644
--- a/pandas/core/util/hashing.py
+++ b/pandas/core/util/hashing.py
@@ -94,6 +94,7 @@ def hash_pandas_object(
Parameters
----------
obj : Index, Series, or DataFrame
+ The input object to hash.
index : bool, default True
Include the index in the hash (if Series/DataFrame).
encoding : str, default 'utf8'
@@ -106,9 +107,14 @@ def hash_pandas_object(
Returns
-------
- Series of uint64
- Same length as the object.
+ Series
+ Containing unsigned integers, same length as object.
+ See Also
+ --------
+ util.hash_tuples : Hash an MultiIndex / listlike-of-tuples efficiently.
+ util.hash_array : Hash an array.
+
Examples
--------
>>> pd.util.hash_pandas_object(pd.Series([1, 2, 3]))
From ca53b758e00dcf80d54dd3e1e9288d317614bbd9 Mon Sep 17 00:00:00 2001
From: Connor <olivecon@oregonstate.edu>
Date: Tue, 11 Mar 2025 16:31:43 -0700
Subject: [PATCH 2/2] Remove trailing whitespace found in pre-commit runs
---
pandas/core/util/hashing.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pandas/core/util/hashing.py b/pandas/core/util/hashing.py
index 931e7e32e07a0..b5a69565499c4 100644
--- a/pandas/core/util/hashing.py
+++ b/pandas/core/util/hashing.py
@@ -114,7 +114,7 @@ def hash_pandas_object(
--------
util.hash_tuples : Hash an MultiIndex / listlike-of-tuples efficiently.
util.hash_array : Hash an array.
-
+
Examples
--------
>>> pd.util.hash_pandas_object(pd.Series([1, 2, 3]))