Skip to content

Commit 4ab9225

Browse files
committed
fix
1 parent 1de9e73 commit 4ab9225

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

pandas/core/indexes/base.py

+28-21
Original file line numberDiff line numberDiff line change
@@ -1286,7 +1286,7 @@ def set_names(self, names, level=None, inplace=False):
12861286
----------
12871287
names : label or list of labels
12881288
Name(s) to set.
1289-
level : int, str or list of labels, optional
1289+
level : int, label or list of labels, optional
12901290
If the index is a MultiIndex, level(s) to set (None for all
12911291
levels). Otherwise level must be None.
12921292
inplace : boolean, default False
@@ -1310,17 +1310,20 @@ def set_names(self, names, level=None, inplace=False):
13101310
>>> idx.set_names('quarter')
13111311
Int64Index([1, 2, 3, 4], dtype='int64', name='quarter')
13121312
1313-
>>> idx = pd.MultiIndex.from_tuples([(1, 'one'), (1, 'two'),
1314-
... (2, 'one'), (2, 'two')],
1315-
... names=['year', 'company'])
1316-
>>> idx.set_names(['term', 'corporation'])
1317-
MultiIndex(levels=[[1, 2], ['one', 'two']],
1318-
labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1319-
names=['term', 'corporation'])
1320-
>>> idx.set_names('association', level=1)
1321-
MultiIndex(levels=[[1, 2], ['one', 'two']],
1322-
labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1323-
names=['year', 'association'])
1313+
>>> idx = pd.MultiIndex.from_product([['python', 'cobra'],
1314+
... [2018, 2019]])
1315+
>>> idx
1316+
MultiIndex(levels=[['cobra', 'python'], [2018, 2019]],
1317+
labels=[[1, 1, 0, 0], [0, 1, 0, 1]])
1318+
>>> idx.set_names(['kind', 'year'], inplace=True)
1319+
>>> idx
1320+
MultiIndex(levels=[['cobra', 'python'], [2018, 2019]],
1321+
labels=[[1, 1, 0, 0], [0, 1, 0, 1]],
1322+
names=['kind', 'year'])
1323+
>>> idx.set_names('species', level=0)
1324+
MultiIndex(levels=[['cobra', 'python'], [2018, 2019]],
1325+
labels=[[1, 1, 0, 0], [0, 1, 0, 1]],
1326+
names=['species', 'year'])
13241327
"""
13251328

13261329
from .multi import MultiIndex
@@ -1329,7 +1332,7 @@ def set_names(self, names, level=None, inplace=False):
13291332

13301333
if level is not None and not is_list_like(level) and is_list_like(
13311334
names):
1332-
msg = "Names must be a string when one level is provided."
1335+
msg = "Names must be a string when a single level is provided."
13331336
raise TypeError(msg)
13341337

13351338
if not is_list_like(names) and level is None and self.nlevels > 1:
@@ -1378,14 +1381,18 @@ def rename(self, name, inplace=False):
13781381
>>> idx.rename('grade')
13791382
Index(['A', 'C', 'A', 'B'], dtype='object', name='grade')
13801383
1381-
>>> idx = pd.MultiIndex.from_tuples([(1, 'one'), (1, 'two'),
1382-
... (2, 'one'), (2, 'two')],
1383-
... names=['year', 'company'])
1384-
>>> idx.rename(['term', 'corporation'])
1385-
MultiIndex(levels=[[1, 2], ['one', 'two']],
1386-
labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1387-
names=['term', 'corporation'])
1388-
>>> idx.rename('term')
1384+
>>> idx = pd.MultiIndex.from_product([['python', 'cobra'],
1385+
... [2018, 2019]],
1386+
... names=['kind', 'year'])
1387+
>>> idx
1388+
MultiIndex(levels=[['cobra', 'python'], [2018, 2019]],
1389+
labels=[[1, 1, 0, 0], [0, 1, 0, 1]],
1390+
names=['kind', 'year'])
1391+
>>> idx.rename(['species', 'year'])
1392+
MultiIndex(levels=[['cobra', 'python'], [2018, 2019]],
1393+
labels=[[1, 1, 0, 0], [0, 1, 0, 1]],
1394+
names=['species', 'year'])
1395+
>>> idx.rename('species')
13891396
Traceback (most recent call last):
13901397
TypeError: Must pass list-like as `names`.
13911398
"""

0 commit comments

Comments
 (0)