Skip to content

Commit 83fec18

Browse files
DOC: fix ES01 for pandas.Flags (#57563)
fix ES01 for pandas.Flags
1 parent 1debaf3 commit 83fec18

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
521521
pandas.DatetimeIndex.year\
522522
pandas.DatetimeTZDtype.tz\
523523
pandas.DatetimeTZDtype.unit\
524-
pandas.Flags\
525524
pandas.HDFStore.get\
526525
pandas.HDFStore.info\
527526
pandas.HDFStore.keys\

pandas/core/flags.py

+9
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ class Flags:
1111
"""
1212
Flags that apply to pandas objects.
1313
14+
“Flags” differ from “metadata”. Flags reflect properties of the pandas
15+
object (the Series or DataFrame). Metadata refer to properties of the
16+
dataset, and should be stored in DataFrame.attrs.
17+
1418
Parameters
1519
----------
1620
obj : Series or DataFrame
@@ -30,6 +34,11 @@ class Flags:
3034
it is expected that every method taking or returning one or more
3135
DataFrame or Series objects will propagate ``allows_duplicate_labels``.
3236
37+
See Also
38+
--------
39+
DataFrame.attrs : Dictionary of global attributes of this dataset.
40+
Series.attrs : Dictionary of global attributes of this dataset.
41+
3342
Examples
3443
--------
3544
Attributes can be set in two ways:

0 commit comments

Comments
 (0)