Skip to content

DOC: fix PR07,SA01 for pandas.MultiIndex.append #59354

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.

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 1 commit into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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.append PR07,SA01" \
-i "pandas.MultiIndex.copy PR07,RT03,SA01" \
-i "pandas.MultiIndex.get_level_values SA01" \
-i "pandas.MultiIndex.get_loc PR07" \
Expand Down
13 changes: 13 additions & 0 deletions pandas/core/indexes/multi.py
Original file line number Diff line number Diff line change
Expand Up @@ -2223,15 +2223,28 @@ def append(self, other):
"""
Append a collection of Index options together.

The `append` method is used to combine multiple `Index` objects into a single
`Index`. This is particularly useful when dealing with multi-level indexing
(MultiIndex) where you might need to concatenate different levels of indices.
The method handles the alignment of the levels and codes of the indices being
appended to ensure consistency in the resulting `MultiIndex`.

Parameters
----------
other : Index or list/tuple of indices
Index or list/tuple of Index objects to be appended.

Returns
-------
Index
The combined index.

See Also
--------
MultiIndex: A multi-level, or hierarchical, index object for pandas objects.
Index.append : Append a collection of Index options together.
concat : Concatenate pandas objects along a particular axis.

Examples
--------
>>> mi = pd.MultiIndex.from_arrays([["a"], ["b"]])
Expand Down
Loading