Skip to content

Commit 9ada608

Browse files
DOC: fix PR07,SA01 for pandas.util.hash_array (#58877)
1 parent 6c55f5e commit 9ada608

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -788,7 +788,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
788788
-i "pandas.tseries.offsets.YearEnd.normalize GL08" \
789789
-i "pandas.tseries.offsets.YearEnd.rule_code GL08" \
790790
-i "pandas.unique PR07" \
791-
-i "pandas.util.hash_array PR07,SA01" \
792791
-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
793792

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

pandas/core/util/hashing.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,7 @@ def hash_array(
244244
Parameters
245245
----------
246246
vals : ndarray or ExtensionArray
247+
The input array to hash.
247248
encoding : str, default 'utf8'
248249
Encoding for data & key when strings.
249250
hash_key : str, default _default_hash_key
@@ -257,6 +258,11 @@ def hash_array(
257258
ndarray[np.uint64, ndim=1]
258259
Hashed values, same length as the vals.
259260
261+
See Also
262+
--------
263+
util.hash_pandas_object : Return a data hash of the Index/Series/DataFrame.
264+
util.hash_tuples : Hash an MultiIndex / listlike-of-tuples efficiently.
265+
260266
Examples
261267
--------
262268
>>> pd.util.hash_array(np.array([1, 2, 3]))

0 commit comments

Comments
 (0)