@@ -2788,26 +2788,45 @@ def set_value(self, arr, key, value):
2788
2788
2789
2789
def _get_level_values (self , level ):
2790
2790
"""
2791
+ Return an Index of values for requested level, specially useful for
2792
+ MultiIndex.
2793
+
2791
2794
Return an Index of values for requested level, equal to the length
2792
- of the index.
2795
+ of the index. This is mainly useful for MultiIndex.
2793
2796
2794
2797
Parameters
2795
2798
----------
2796
2799
level : int or str
2797
- ``level`` is either the integer position of the level in the
2798
- MultiIndex, or the name of the level.
2800
+ It is either the integer position or the name of the level.
2801
+ If given as an integer, it must be between 0 and the
2802
+ number of levels - 1.
2799
2803
2800
2804
Returns
2801
2805
-------
2802
2806
values : Index
2803
- `` self` `, as there is only one level in the Index.
2807
+ `self`, as there is only one level in the Index.
2804
2808
2805
2809
See also
2806
2810
---------
2807
2811
pandas.MultiIndex.get_level_values : get values for a level of a
2808
2812
MultiIndex
2809
- """
2810
2813
2814
+ Notes
2815
+ ---------
2816
+ For Index, level should be 0, since there are no multiple levels.
2817
+
2818
+ Examples
2819
+ ---------
2820
+
2821
+ >>> idx = pd.Index(list('abc'))
2822
+ >>> idx
2823
+ Index(['a', 'b', 'c'], dtype='object')
2824
+
2825
+ Get level value by supplying level as integer:
2826
+
2827
+ >>> idx.get_level_values(0)
2828
+ Index(['a', 'b', 'c'], dtype='object')
2829
+ """
2811
2830
self ._validate_index_level (level )
2812
2831
return self
2813
2832
0 commit comments