Examples in MultiIndex.rename documentation do not call the function

[nmusolino]

Code Sample

In Pandas version 0.20, The documentation for the function pandas.MultiIndex.rename includes an "Examples" section with five lines of Python code.

Here are the examples:

>>> Index([1, 2, 3, 4]).set_names('foo')
Int64Index([1, 2, 3, 4], dtype='int64')
>>> Index([1, 2, 3, 4]).set_names(['foo'])
Int64Index([1, 2, 3, 4], dtype='int64')
>>> idx = MultiIndex.from_tuples([(1, u'one'), (1, u'two'),
                                  (2, u'one'), (2, u'two')],
                                  names=['foo', 'bar'])
>>> idx.set_names(['baz', 'quz'])
MultiIndex(levels=[[1, 2], [u'one', u'two']],
           labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
           names=[u'baz', u'quz'])
>>> idx.set_names('baz', level=0)
MultiIndex(levels=[[1, 2], [u'one', u'two']],
           labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
           names=[u'baz', u'bar'])

Problem description

The examples do not call the MultiIndex.rename function. Expected contents of the documentation: the examples given for the rename function should actually call the rename function.

Output of pd.show_versions()

N/A, documentation bug.

Meta note

The link above will begin pointing at documentation for a different version of Pandas once the successor to version 0.20 is released as a stable version. Unfortunately, there is no link to version 0.20 documentation per se on the pandas homepage.

[chris-b1]

Thanks, yeah, something strange happening with the sphinx build. The actual docstring is fine, but somehow set_names is being parsed into rename. @jorisvandenbossche ?

https://github.com/pandas-dev/pandas/blob/v0.20.3/pandas/core/indexes/base.py#L1125

[jorisvandenbossche]

If you look at the actual docstring in a console, it is what is shown on the web page. And It is due to this line: https://github.com/pandas-dev/pandas/blob/v0.20.3/pandas/core/indexes/multi.py#L78

So rename is set to set_names, and therefore takes it docstring.

[VincentLa]

Interesting, so in looking at this more deeply, it looks like rename and set_names are equivalent. Is that correct?

[mroeschke]

Looks like MutiIndex.rename no longer exists, so closing this issue