Skip to content

Commit 4cd6825

Browse files
topper-123No-Stream
authored andcommitted
DOC: Added example to MultiIndex doc string (pandas-dev#17653)
1 parent 9246473 commit 4cd6825

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

pandas/core/indexes/multi.py

+27
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,33 @@ class MultiIndex(Index):
6868
Copy the meta-data
6969
verify_integrity : boolean, default True
7070
Check that the levels/labels are consistent and valid
71+
72+
Examples
73+
---------
74+
A new ``MultiIndex`` is typically constructed using one of the helper
75+
methods :meth:`MultiIndex.from_arrays``, :meth:`MultiIndex.from_product``
76+
and :meth:`MultiIndex.from_tuples``. For example (using ``.from_arrays``):
77+
78+
>>> arrays = [[1, 1, 2, 2], ['red', 'blue', 'red', 'blue']]
79+
>>> pd.MultiIndex.from_arrays(arrays, names=('number', 'color'))
80+
MultiIndex(levels=[[1, 2], ['blue', 'red']],
81+
labels=[[0, 0, 1, 1], [1, 0, 1, 0]],
82+
names=['number', 'color'])
83+
84+
See further examples for how to construct a MultiIndex in the doc strings
85+
of the mentioned helper methods.
86+
87+
Notes
88+
-----
89+
See the `user guide
90+
<http://pandas.pydata.org/pandas-docs/stable/advanced.html>`_ for more.
91+
92+
See Also
93+
--------
94+
MultiIndex.from_arrays : Convert list of arrays to MultiIndex
95+
MultiIndex.from_product : Create a MultiIndex from the cartesian product
96+
of iterables
97+
MultiIndex.from_tuples : Convert list of tuples to a MultiIndex
7198
"""
7299

73100
# initialize to zero-length tuples to make everything work

0 commit comments

Comments
 (0)