Skip to content

Commit 2bd6954

Browse files
DOC: fix ES01,SA01 for pandas.MultiIndex.names (#59520)
DOC: fix ES01,PR07 for pandas.MultiIndex.names
1 parent b376797 commit 2bd6954

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7070
--format=actions \
7171
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
7272
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
73-
-i "pandas.MultiIndex.names SA01" \
7473
-i "pandas.MultiIndex.reorder_levels RT03,SA01" \
7574
-i "pandas.MultiIndex.to_frame RT03" \
7675
-i "pandas.NA SA01" \

pandas/core/indexes/multi.py

+11
Original file line numberDiff line numberDiff line change
@@ -1636,6 +1636,17 @@ def _set_names(self, names, *, level=None, validate: bool = True) -> None:
16361636
doc="""
16371637
Names of levels in MultiIndex.
16381638
1639+
This attribute provides access to the names of the levels in a `MultiIndex`.
1640+
The names are stored as a `FrozenList`, which is an immutable list-like
1641+
container. Each name corresponds to a level in the `MultiIndex`, and can be
1642+
used to identify or manipulate the levels individually.
1643+
1644+
See Also
1645+
--------
1646+
MultiIndex.set_names : Set Index or MultiIndex name.
1647+
MultiIndex.rename : Rename specific levels in a MultiIndex.
1648+
Index.names : Get names on index.
1649+
16391650
Examples
16401651
--------
16411652
>>> mi = pd.MultiIndex.from_arrays(

0 commit comments

Comments
 (0)