Skip to content

Commit 9694755

Browse files
author
Jon M. Mease
committed
Convert _get_grouper_for_level doc-strings on Index/MultiIndex to shared_doc (GH 14327)
1 parent ab05b34 commit 9694755

File tree

2 files changed

+8
-24
lines changed

2 files changed

+8
-24
lines changed

pandas/indexes/base.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -432,26 +432,28 @@ def _update_inplace(self, result, **kwargs):
432432
# guard when called from IndexOpsMixin
433433
raise TypeError("Index can't be updated inplace")
434434

435-
def _get_grouper_for_level(self, mapper, level=None):
436-
"""
435+
_index_shared_docs['_get_grouper_for_level'] = """
437436
Get index grouper corresponding to an index level
438437
439438
Parameters
440439
----------
441440
mapper: Group mapping function or None
442441
Function mapping index values to groups
443-
level : int, default None
442+
level : int or None
444443
Index level
445444
446445
Returns
447446
-------
448447
grouper : Index
449448
Index of values to group on
450-
labels : None
449+
labels : ndarray of int or None
451450
Array of locations in level_index
452-
level_index : None
451+
uniques : Index or None
453452
Index of unique values for level
454453
"""
454+
455+
@Appender(_index_shared_docs['_get_grouper_for_level'])
456+
def _get_grouper_for_level(self, mapper, level=None):
455457
assert level is None or level == 0
456458
if mapper is None:
457459
grouper = self

pandas/indexes/multi.py

+1-19
Original file line numberDiff line numberDiff line change
@@ -539,26 +539,8 @@ def _format_native_types(self, na_rep='nan', **kwargs):
539539

540540
return mi.values
541541

542+
@Appender(_index_shared_docs['_get_grouper_for_level'])
542543
def _get_grouper_for_level(self, mapper, level):
543-
"""
544-
Get index grouper corresponding to an index level
545-
546-
Parameters
547-
----------
548-
mapper: Group mapping function or None
549-
Function mapping index values to groups
550-
level : int
551-
Index level
552-
553-
Returns
554-
-------
555-
grouper : Index
556-
Index of values to group on
557-
labels : ndarray of int or None
558-
Array of locations in level_index
559-
uniques : Index or None
560-
Index of unique values for level
561-
"""
562544
indexer = self.labels[level]
563545
level_index = self.levels[level]
564546

0 commit comments

Comments
 (0)