Skip to content

Commit 19bafbe

Browse files
committed
Merge pull request #11893 from Dr-Irv/multidoc
DOC: Put MultiIndex into the main API Reference
2 parents 1d7521b + 211ad94 commit 19bafbe

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

doc/source/api.rst

+28
Original file line numberDiff line numberDiff line change
@@ -581,6 +581,7 @@ strings and apply several methods to it. These can be accessed like
581581
Series.dt
582582
Index.str
583583
CategoricalIndex.str
584+
MultiIndex.str
584585
DatetimeIndex.str
585586
TimedeltaIndex.str
586587

@@ -1405,6 +1406,33 @@ Categorical Components
14051406
CategoricalIndex.as_ordered
14061407
CategoricalIndex.as_unordered
14071408

1409+
.. _api.multiindex:
1410+
1411+
MultiIndex
1412+
----------
1413+
1414+
.. autosummary::
1415+
:toctree: generated/
1416+
1417+
MultiIndex
1418+
1419+
MultiIndex Components
1420+
~~~~~~~~~~~~~~~~~~~~~~
1421+
1422+
.. autosummary::
1423+
:toctree: generated/
1424+
1425+
MultiIndex.from_arrays
1426+
MultiIndex.from_tuples
1427+
MultiIndex.from_product
1428+
MultiIndex.set_levels
1429+
MultiIndex.set_labels
1430+
MultiIndex.to_hierarchical
1431+
MultiIndex.is_lexsorted
1432+
MultiIndex.droplevel
1433+
MultiIndex.swaplevel
1434+
MultiIndex.reorder_levels
1435+
14081436
.. _api.datetimeindex:
14091437

14101438
DatetimeIndex

pandas/core/index.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -4030,8 +4030,7 @@ def isin(self, values, level=None):
40304030
class MultiIndex(Index):
40314031

40324032
"""
4033-
Implements multi-level, a.k.a. hierarchical, index object for pandas
4034-
objects
4033+
A multi-level, or hierarchical, index object for pandas objects
40354034
40364035
Parameters
40374036
----------

0 commit comments

Comments
 (0)