Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Series.cat.codes #58527

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 2 commits into from
May 2, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Series.cat.codes #58527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
496664d
DOC: add SA01 for pandas.Series.cat.codes
tuhinsharma121 May 2, 2024
93ad30f
DOC: remove SA01 for pandas.Series.cat.codes
tuhinsharma121 May 2, 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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.cat.add_categories PR01,PR02" \
-i "pandas.Series.cat.as_ordered PR01" \
-i "pandas.Series.cat.as_unordered PR01" \
-i "pandas.Series.cat.codes SA01" \
-i "pandas.Series.cat.remove_categories PR01,PR02" \
-i "pandas.Series.cat.remove_unused_categories PR01" \
-i "pandas.Series.cat.rename_categories PR01,PR02" \
Expand Down
6 changes: 6 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 @@ -2987,6 +2987,12 @@ def codes(self) -> Series:
"""
Return Series of codes as well as the index.

See Also
--------
Series.cat.categories : Return the categories of this categorical.
Series.cat.as_ordered : Set the Categorical to be ordered.
Series.cat.as_unordered : Set the Categorical to be unordered.

Examples
--------
>>> raw_cate = pd.Categorical(["a", "b", "c", "a"], categories=["a", "b"])
Expand Down