Skip to content

Commit 8f6b9e5

Browse files
author
tp
committed
Correct wrong doc string for MultiIndex.get_loc_level + added examples
1 parent d43aba8 commit 8f6b9e5

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

pandas/core/indexes/multi.py

+30-4
Original file line numberDiff line numberDiff line change
@@ -2056,16 +2056,42 @@ def _maybe_str_to_time_stamp(key, lev):
20562056

20572057
def get_loc_level(self, key, level=0, drop_level=True):
20582058
"""
2059-
Get integer location slice for requested label or tuple
2059+
Get both the location for the requested label(s) and the
2060+
resulting sliced index.
20602061
20612062
Parameters
20622063
----------
2063-
key : label or tuple
2064-
level : int/level name or list thereof
2064+
key : label or sequence of labels
2065+
level : int/level name or list thereof, optional
2066+
drop_level : bool, default True
2067+
if ``False``, the output index will not be sliced.
20652068
20662069
Returns
20672070
-------
2068-
loc : int or slice object
2071+
loc : A 2-tuple where the elements are:
2072+
Element 0: int, slice object or boolean array
2073+
Element 1: The resulting sliced multiindex/index. If the key
2074+
contains all levels, this will be ``None``.
2075+
2076+
Examples
2077+
--------
2078+
>>> mi = pd.MultiIndex.from_arrays([list('abb'), list('def')],
2079+
... names=['A', 'B'])
2080+
2081+
>>> mi.get_loc_level('b')
2082+
(slice(1, 3, None), Index(['e', 'f'], dtype='object', name='B'))
2083+
2084+
>>> mi.get_loc_level('e', level='B')
2085+
(array([False, True, False], dtype=bool),
2086+
Index(['b'], dtype='object', name='A'))
2087+
2088+
>>> mi.get_loc_level(['b', 'e'])
2089+
(1, None)
2090+
2091+
See Also
2092+
---------
2093+
MultiIndex.get_loc : Get integer location, slice or boolean mask for
2094+
requested label or tuple.
20692095
"""
20702096

20712097
def maybe_droplevels(indexer, levels, drop_level):

0 commit comments

Comments
 (0)