Skip to content

Commit

Permalink
DOC: fix ES01,PR07 for pandas.MultiIndex.get_loc_level (#59450)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Aug 8, 2024
1 parent 3182e9b commit 93198fb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
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.get_loc_level PR07" \
-i "pandas.MultiIndex.names SA01" \
-i "pandas.MultiIndex.reorder_levels RT03,SA01" \
-i "pandas.MultiIndex.sortlevel PR07,SA01" \
Expand Down
11 changes: 11 additions & 0 deletions pandas/core/indexes/multi.py
Original file line number Diff line number Diff line change
Expand Up @@ -3178,10 +3178,21 @@ def get_loc_level(self, key, level: IndexLabel = 0, drop_level: bool = True):
"""
Get location and sliced index for requested label(s)/level(s).
The `get_loc_level` method is a more advanced form of `get_loc`, allowing
users to specify not just a label or sequence of labels, but also the level(s)
in which to search. This method is useful when you need to isolate particular
sections of a MultiIndex, either for further analysis or for slicing and
dicing the data. The method provides flexibility in terms of maintaining
or dropping levels from the resulting index based on the `drop_level`
parameter.
Parameters
----------
key : label or sequence of labels
The label(s) for which to get the location.
level : int/level name or list thereof, optional
The level(s) in the MultiIndex to consider. If not provided, defaults
to the first level.
drop_level : bool, default True
If ``False``, the resulting index will not drop any level.
Expand Down

0 comments on commit 93198fb

Please sign in to comment.