@@ -3090,26 +3090,41 @@ def set_value(self, arr, key, value):
3090
3090
3091
3091
def _get_level_values (self , level ):
3092
3092
"""
3093
- Return an Index of values for requested level, equal to the length
3094
- of the index.
3093
+ Return an Index of values for requested level.
3094
+
3095
+ This is primarily useful to get an individual level of values from a
3096
+ MultiIndex, but is provided on Index as well for compatability.
3095
3097
3096
3098
Parameters
3097
3099
----------
3098
3100
level : int or str
3099
- ``level`` is either the integer position of the level in the
3100
- MultiIndex, or the name of the level.
3101
+ It is either the integer position or the name of the level.
3101
3102
3102
3103
Returns
3103
3104
-------
3104
3105
values : Index
3105
- ``self`` , as there is only one level in the Index.
3106
+ Calling object , as there is only one level in the Index.
3106
3107
3107
3108
See also
3108
- ---------
3109
- pandas.MultiIndex.get_level_values : get values for a level of a
3110
- MultiIndex
3111
- """
3109
+ --------
3110
+ MultiIndex.get_level_values : get values for a level of a MultiIndex
3111
+
3112
+ Notes
3113
+ -----
3114
+ For Index, level should be 0, since there are no multiple levels.
3112
3115
3116
+ Examples
3117
+ --------
3118
+
3119
+ >>> idx = pd.Index(list('abc'))
3120
+ >>> idx
3121
+ Index(['a', 'b', 'c'], dtype='object')
3122
+
3123
+ Get level values by supplying `level` as integer:
3124
+
3125
+ >>> idx.get_level_values(0)
3126
+ Index(['a', 'b', 'c'], dtype='object')
3127
+ """
3113
3128
self ._validate_index_level (level )
3114
3129
return self
3115
3130
0 commit comments