Skip to content

Commit 211ad94

Browse files
committed
Put MultiIndex into the main API Reference
1 parent 6b8a721 commit 211ad94

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
@@ -572,6 +572,7 @@ strings and apply several methods to it. These can be accessed like
572572
Series.dt
573573
Index.str
574574
CategoricalIndex.str
575+
MultiIndex.str
575576
DatetimeIndex.str
576577
TimedeltaIndex.str
577578

@@ -1396,6 +1397,33 @@ Categorical Components
13961397
CategoricalIndex.as_ordered
13971398
CategoricalIndex.as_unordered
13981399

1400+
.. _api.multiindex:
1401+
1402+
MultiIndex
1403+
----------
1404+
1405+
.. autosummary::
1406+
:toctree: generated/
1407+
1408+
MultiIndex
1409+
1410+
MultiIndex Components
1411+
~~~~~~~~~~~~~~~~~~~~~~
1412+
1413+
.. autosummary::
1414+
:toctree: generated/
1415+
1416+
MultiIndex.from_arrays
1417+
MultiIndex.from_tuples
1418+
MultiIndex.from_product
1419+
MultiIndex.set_levels
1420+
MultiIndex.set_labels
1421+
MultiIndex.to_hierarchical
1422+
MultiIndex.is_lexsorted
1423+
MultiIndex.droplevel
1424+
MultiIndex.swaplevel
1425+
MultiIndex.reorder_levels
1426+
13991427
.. _api.datetimeindex:
14001428

14011429
DatetimeIndex

pandas/core/index.py

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

40244024
"""
4025-
Implements multi-level, a.k.a. hierarchical, index object for pandas
4026-
objects
4025+
A multi-level, or hierarchical, index object for pandas objects
40274026
40284027
Parameters
40294028
----------

0 commit comments

Comments
 (0)