Skip to content

DOC: Add RT03,SA01 for pandas.api.types.union_categoricals #59319

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
Jul 26, 2024
+6 −1
Merged

DOC: Add RT03,SA01 for pandas.api.types.union_categoricals #59319

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
d0cb5d3
Add RT03,SA01 for pandas.api.types.union_categoricals
zslsally Jul 26, 2024
ff49fe4
Update after rerun the check
zslsally Jul 26, 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 @@ -307,7 +307,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_string_dtype SA01" \
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
-i "pandas.api.types.union_categoricals RT03,SA01" \
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
-i "pandas.arrays.BooleanArray SA01" \
-i "pandas.arrays.DatetimeArray SA01" \
Expand Down
6 changes: 6 additions & 0 deletions pandas/core/dtypes/concat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def union_categoricals(
Returns
-------
Categorical
The union of categories being combined.

Raises
------
Expand All @@ -201,6 +202,11 @@ def union_categoricals(
ValueError
Empty list of categoricals passed

See Also
--------
CategoricalDtype : Type for categorical data with the categories and orderedness.
Categorical : Represent a categorical variable in classic R / S-plus fashion.

Notes
-----
To learn more about categories, see `link
Expand Down