Skip to content

DOC: fix ES01,SA01 for pandas.MultiIndex.names #59520

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
Aug 15, 2024
Merged

DOC: fix ES01,SA01 for pandas.MultiIndex.names #59520

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
a7c1990
DOC: fix ES01,PR07 for pandas.MultiIndex.names
tuhinsharma121 Aug 15, 2024
7543df3
Merge branch 'main' into pandas.MultiIndex.names
tuhinsharma121 Aug 15, 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 @@ -70,7 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
--format=actions \
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
-i "pandas.MultiIndex.names SA01" \
-i "pandas.MultiIndex.reorder_levels RT03,SA01" \
-i "pandas.MultiIndex.sortlevel PR07,SA01" \
-i "pandas.MultiIndex.to_frame RT03" \
Expand Down
11 changes: 11 additions & 0 deletions pandas/core/indexes/multi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1636,6 +1636,17 @@ def _set_names(self, names, *, level=None, validate: bool = True) -> None:
doc="""
Names of levels in MultiIndex.

This attribute provides access to the names of the levels in a `MultiIndex`.
The names are stored as a `FrozenList`, which is an immutable list-like
container. Each name corresponds to a level in the `MultiIndex`, and can be
used to identify or manipulate the levels individually.

See Also
--------
MultiIndex.set_names : Set Index or MultiIndex name.
MultiIndex.rename : Rename specific levels in a MultiIndex.
Index.names : Get names on index.

Examples
--------
>>> mi = pd.MultiIndex.from_arrays(
Expand Down