Skip to content

DOC: fix ES01 for pandas.Flags #57563

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
mroeschke merged 1 commit into from
Feb 22, 2024
Merged

DOC: fix ES01 for pandas.Flags #57563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -521,7 +521,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.DatetimeIndex.year\
pandas.DatetimeTZDtype.tz\
pandas.DatetimeTZDtype.unit\
pandas.Flags\
pandas.HDFStore.get\
pandas.HDFStore.info\
pandas.HDFStore.keys\
Expand Down
9 changes: 9 additions & 0 deletions pandas/core/flags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ class Flags:
"""
Flags that apply to pandas objects.

“Flags” differ from “metadata”. Flags reflect properties of the pandas
object (the Series or DataFrame). Metadata refer to properties of the
dataset, and should be stored in DataFrame.attrs.

Parameters
----------
obj : Series or DataFrame
Expand All @@ -30,6 +34,11 @@ class Flags:
it is expected that every method taking or returning one or more
DataFrame or Series objects will propagate ``allows_duplicate_labels``.

See Also
--------
DataFrame.attrs : Dictionary of global attributes of this dataset.
Series.attrs : Dictionary of global attributes of this dataset.

Examples
--------
Attributes can be set in two ways:
Expand Down