Skip to content

Commit e28ebe3

Browse files
jorisvandenbosscheTomAugspurger
authored andcommitted
DOC: Add MultiIndex.get_locs to generated reference (#30234)
* DOC: Add MultiIndex.get_locs to generated reference * fixups
1 parent 4fe7c99 commit e28ebe3

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

doc/source/reference/indexing.rst

+1
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,7 @@ MultiIndex selecting
313313
:toctree: api/
314314

315315
MultiIndex.get_loc
316+
MultiIndex.get_locs
316317
MultiIndex.get_loc_level
317318
MultiIndex.get_indexer
318319
MultiIndex.get_level_values

pandas/core/indexes/multi.py

+13-13
Original file line numberDiff line numberDiff line change
@@ -2879,37 +2879,37 @@ def convert_indexer(start, stop, step, indexer=indexer, codes=level_codes):
28792879

28802880
def get_locs(self, seq):
28812881
"""
2882-
Get location for a given label/slice/list/mask or a sequence of such as
2883-
an array of integers.
2882+
Get location for a sequence of labels.
28842883
28852884
Parameters
28862885
----------
2887-
seq : label/slice/list/mask or a sequence of such
2886+
seq : label, slice, list, mask or a sequence of such
28882887
You should use one of the above for each level.
28892888
If a level should not be used, set it to ``slice(None)``.
28902889
28912890
Returns
28922891
-------
2893-
locs : array of integers suitable for passing to iloc
2892+
numpy.ndarray
2893+
NumPy array of integers suitable for passing to iloc.
2894+
2895+
See Also
2896+
--------
2897+
MultiIndex.get_loc : Get location for a label or a tuple of labels.
2898+
MultiIndex.slice_locs : Get slice location given start label(s) and
2899+
end label(s).
28942900
28952901
Examples
28962902
--------
28972903
>>> mi = pd.MultiIndex.from_arrays([list('abb'), list('def')])
28982904
2899-
>>> mi.get_locs('b')
2905+
>>> mi.get_locs('b') # doctest: +SKIP
29002906
array([1, 2], dtype=int64)
29012907
2902-
>>> mi.get_locs([slice(None), ['e', 'f']])
2908+
>>> mi.get_locs([slice(None), ['e', 'f']]) # doctest: +SKIP
29032909
array([1, 2], dtype=int64)
29042910
2905-
>>> mi.get_locs([[True, False, True], slice('e', 'f')])
2911+
>>> mi.get_locs([[True, False, True], slice('e', 'f')]) # doctest: +SKIP
29062912
array([2], dtype=int64)
2907-
2908-
See Also
2909-
--------
2910-
MultiIndex.get_loc : Get location for a label or a tuple of labels.
2911-
MultiIndex.slice_locs : Get slice location given start label(s) and
2912-
end label(s).
29132913
"""
29142914
from .numeric import Int64Index
29152915

0 commit comments

Comments
 (0)