Skip to content

Commit 7e7735b

Browse files
DOC: fix PR07,SA01 for pandas.MultiIndex.append (#59354)
1 parent dd2dbcd commit 7e7735b

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-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.append PR07,SA01" \
7473
-i "pandas.MultiIndex.copy PR07,RT03,SA01" \
7574
-i "pandas.MultiIndex.get_level_values SA01" \
7675
-i "pandas.MultiIndex.get_loc PR07" \

pandas/core/indexes/multi.py

+13
Original file line numberDiff line numberDiff line change
@@ -2223,15 +2223,28 @@ def append(self, other):
22232223
"""
22242224
Append a collection of Index options together.
22252225
2226+
The `append` method is used to combine multiple `Index` objects into a single
2227+
`Index`. This is particularly useful when dealing with multi-level indexing
2228+
(MultiIndex) where you might need to concatenate different levels of indices.
2229+
The method handles the alignment of the levels and codes of the indices being
2230+
appended to ensure consistency in the resulting `MultiIndex`.
2231+
22262232
Parameters
22272233
----------
22282234
other : Index or list/tuple of indices
2235+
Index or list/tuple of Index objects to be appended.
22292236
22302237
Returns
22312238
-------
22322239
Index
22332240
The combined index.
22342241
2242+
See Also
2243+
--------
2244+
MultiIndex: A multi-level, or hierarchical, index object for pandas objects.
2245+
Index.append : Append a collection of Index options together.
2246+
concat : Concatenate pandas objects along a particular axis.
2247+
22352248
Examples
22362249
--------
22372250
>>> mi = pd.MultiIndex.from_arrays([["a"], ["b"]])

0 commit comments

Comments
 (0)