Skip to content

Commit 623cc3a

Browse files
committed
ref pandas-dev#28294 added docs for MultiIndex.set_levels
rectify for failing tests DOC: added docs for MultiIndex.set_levels (pandas-dev#28294)
1 parent 6396bc3 commit 623cc3a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/source/user_guide/advanced.rst

+26
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,32 @@ completely analogous way to selecting a column in a regular DataFrame:
177177
See :ref:`Cross-section with hierarchical index <advanced.xs>` for how to select
178178
on a deeper level.
179179

180+
.. _advanced.set_levels:
181+
182+
Set values in levels
183+
~~~~~~~~~~~~~~
184+
185+
The method :meth:`~MultiIndex.set_levels` changes the ``levels`` attribute by
186+
passing a new value for each index in the level. It is assumed that a new value
187+
is provided for each code describing values in the level.
188+
For example:
189+
190+
.. ipython:: python
191+
192+
df.columns # original MultiIndex columns
193+
194+
df.columns.levels # original MultiIndex column levels
195+
196+
df.columns.set_levels([1, 3, 5, 7], level=0) # set new value for each index in column level 0
197+
198+
df.columns.set_levels([1, 3, 5, 7], level=0).levels # modified index values in column level 0
199+
200+
df.columns.set_levels([1, 3, 5, 7], level=1) # number of values passed > number of index values
201+
202+
df.columns.set_levels([1, 3, 5, 7], level=1).levels # modified index values in column level 1
203+
204+
205+
180206
.. _advanced.shown_levels:
181207

182208
Defined levels

0 commit comments

Comments
 (0)