Skip to content

DOC: fixing PR01 errors for pandas.Categorical and pandas.Categorical.__array__ #57561

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 23, 2024
Merged

DOC: fixing PR01 errors for pandas.Categorical and pandas.Categorical.__array__ #57561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31d195e
fixing PR01 errors for pandas.Categorical and pandas.Categorical.__ar…
jordan-d-murphy Feb 22, 2024
611a92f
Merge remote-tracking branch 'upstream/main' into issue#57438_1
jordan-d-murphy Feb 23, 2024
36fd778
updated dtype to np.dtype
jordan-d-murphy Feb 23, 2024
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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1458,8 +1458,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Partially validate docstrings (PR01)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR01 --ignore_functions \
pandas.Categorical\
pandas.Categorical.__array__\
pandas.CategoricalIndex.equals\
pandas.CategoricalIndex.map\
pandas.DataFrame.at_time\
Expand Down
10 changes: 10 additions & 0 deletions pandas/core/arrays/categorical.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,11 @@ class Categorical(NDArrayBackedExtensionArray, PandasObject, ObjectStringArrayMi
provided).
dtype : CategoricalDtype
An instance of ``CategoricalDtype`` to use for this categorical.
fastpath : bool
The 'fastpath' keyword in Categorical is deprecated and will be
removed in a future version. Use Categorical.from_codes instead.
copy : bool, default True
Whether to copy if the codes are unchanged.

Attributes
----------
Expand Down Expand Up @@ -1657,6 +1662,11 @@ def __array__(self, dtype: NpDtype | None = None) -> np.ndarray:
"""
The numpy array interface.

Parameters
----------
dtype : np.dtype or None
Specifies the the dtype for the array.

Returns
-------
numpy.array
Expand Down