Skip to content

Commit ec244c6

Browse files
DOC: fix ES01,RT03,SA01 for pandas.MultiIndex.remove_unused_levels
1 parent 73b5578 commit ec244c6

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7676
-i "pandas.MultiIndex.get_loc_level PR07" \
7777
-i "pandas.MultiIndex.levshape SA01" \
7878
-i "pandas.MultiIndex.names SA01" \
79-
-i "pandas.MultiIndex.remove_unused_levels RT03,SA01" \
8079
-i "pandas.MultiIndex.reorder_levels RT03,SA01" \
8180
-i "pandas.MultiIndex.set_levels RT03,SA01" \
8281
-i "pandas.MultiIndex.sortlevel PR07,SA01" \

pandas/core/indexes/multi.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2041,9 +2041,22 @@ def remove_unused_levels(self) -> MultiIndex:
20412041
appearance, meaning the same .values and ordering. It will
20422042
also be .equals() to the original.
20432043
2044+
The `remove_unused_levels` method is useful in cases where you have a
2045+
MultiIndex with hierarchical levels, but some of these levels are no
2046+
longer needed due to filtering or subsetting operations. By removing
2047+
the unused levels, the resulting MultiIndex becomes more compact and
2048+
efficient, which can improve performance in subsequent operations.
2049+
20442050
Returns
20452051
-------
20462052
MultiIndex
2053+
A new MultiIndex with unused levels removed.
2054+
2055+
See Also
2056+
--------
2057+
MultiIndex.droplevel : Remove specified levels from a MultiIndex.
2058+
MultiIndex.reorder_levels : Rearrange levels of a MultiIndex.
2059+
MultiIndex.set_levels : Set new levels on a MultiIndex.
20472060
20482061
Examples
20492062
--------

0 commit comments

Comments
 (0)