Skip to content

Commit 1c44d08

Browse files
DOC: Fix docstring validation errors for pandas.util.hash_pandas_object
1 parent 4257ad6 commit 1c44d08

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

ci/code_checks.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
268268
-i "pandas.tseries.offsets.YearEnd.is_on_offset GL08" \
269269
-i "pandas.tseries.offsets.YearEnd.month GL08" \
270270
-i "pandas.tseries.offsets.YearEnd.n GL08" \
271-
-i "pandas.tseries.offsets.YearEnd.normalize GL08" \
272-
-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
271+
-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
273272

274273
RET=$(($RET + $?)) ; echo $MSG "DONE"
275274

pandas/core/util/hashing.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ def hash_pandas_object(
9494
Parameters
9595
----------
9696
obj : Index, Series, or DataFrame
97+
The pandas object to hash. This can be a single-dimensional Index or Series,
98+
or a multi-dimensional DataFrame.
9799
index : bool, default True
98100
Include the index in the hash (if Series/DataFrame).
99101
encoding : str, default 'utf8'
@@ -109,6 +111,11 @@ def hash_pandas_object(
109111
Series of uint64
110112
Same length as the object.
111113
114+
See Also
115+
--------
116+
util.hash_array : Hash the elements of a 1D NumPy or ExtensionArray.
117+
util.combine_hash_arrays : Combine multiple hash arrays into a single hash.
118+
112119
Examples
113120
--------
114121
>>> pd.util.hash_pandas_object(pd.Series([1, 2, 3]))

0 commit comments

Comments
 (0)