Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: fix docstring validation errors for pandas.util.hash_pandas_object and pandas.Timestamp.resolution #61106

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
@@ -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"

10 changes: 8 additions & 2 deletions pandas/core/util/hashing.py
Original file line number Diff line number Diff line change
@@ -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,8 +107,13 @@ 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
--------