Skip to content

Commit a0568e0

Browse files
DOC: Fix SA01,ES01,PR07 for pandas.DataFrame.from_arrow
1 parent a92624d commit a0568e0

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

ci/code_checks.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
278278
-i "pandas.tseries.offsets.YearEnd.is_on_offset GL08" \
279279
-i "pandas.tseries.offsets.YearEnd.month GL08" \
280280
-i "pandas.tseries.offsets.YearEnd.n GL08" \
281-
-i "pandas.tseries.offsets.YearEnd.normalize GL08" \
282-
-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
281+
-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
283282

284283
RET=$(($RET + $?)) ; echo $MSG "DONE"
285284

pandas/core/util/hashing.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,13 @@ def hash_pandas_object(
9191
"""
9292
Return a data hash of the Index/Series/DataFrame.
9393
94+
The hash is computed element-wise using the underlying data values,
95+
and optionally includes the index when hashing a Series or DataFrame.
96+
9497
Parameters
9598
----------
9699
obj : Index, Series, or DataFrame
100+
The pandas object to hash.
97101
index : bool, default True
98102
Include the index in the hash (if Series/DataFrame).
99103
encoding : str, default 'utf8'
@@ -109,6 +113,11 @@ def hash_pandas_object(
109113
Series of uint64
110114
Same length as the object.
111115
116+
See Also
117+
--------
118+
util.hash_array : Return a hash of the given array.
119+
util.hash_tuples : Hash a MultiIndex or listlike-of-tuples efficiently.
120+
112121
Examples
113122
--------
114123
>>> pd.util.hash_pandas_object(pd.Series([1, 2, 3]))

0 commit comments

Comments
 (0)