Skip to content

Commit bb93575

Browse files
asyarif93roberthdevries
authored andcommitted
DOC: Update pandas.DataFrame.droplevel docstring (pandas-dev#32004)
1 parent 0bfbc4f commit bb93575

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

ci/code_checks.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ if [[ -z "$CHECK" || "$CHECK" == "doctests" ]]; then
269269

270270
MSG='Doctests generic.py' ; echo $MSG
271271
pytest -q --doctest-modules pandas/core/generic.py \
272-
-k"-_set_axis_name -_xs -describe -droplevel -groupby -interpolate -pct_change -pipe -reindex -reindex_axis -to_json -transpose -values -xs -to_clipboard"
272+
-k"-_set_axis_name -_xs -describe -groupby -interpolate -pct_change -pipe -reindex -reindex_axis -to_json -transpose -values -xs -to_clipboard"
273273
RET=$(($RET + $?)) ; echo $MSG "DONE"
274274

275275
MSG='Doctests groupby.py' ; echo $MSG

pandas/core/generic.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,10 @@ def droplevel(self: FrameOrSeries, level, axis=0) -> FrameOrSeries:
602602
of levels.
603603
604604
axis : {0 or 'index', 1 or 'columns'}, default 0
605+
Axis along which the level(s) is removed:
606+
607+
* 0 or 'index': remove level(s) in column.
608+
* 1 or 'columns': remove level(s) in row.
605609
606610
Returns
607611
-------
@@ -617,7 +621,7 @@ def droplevel(self: FrameOrSeries, level, axis=0) -> FrameOrSeries:
617621
... ]).set_index([0, 1]).rename_axis(['a', 'b'])
618622
619623
>>> df.columns = pd.MultiIndex.from_tuples([
620-
... ('c', 'e'), ('d', 'f')
624+
... ('c', 'e'), ('d', 'f')
621625
... ], names=['level_1', 'level_2'])
622626
623627
>>> df
@@ -636,7 +640,7 @@ def droplevel(self: FrameOrSeries, level, axis=0) -> FrameOrSeries:
636640
6 7 8
637641
10 11 12
638642
639-
>>> df.droplevel('level2', axis=1)
643+
>>> df.droplevel('level_2', axis=1)
640644
level_1 c d
641645
a b
642646
1 2 3 4

0 commit comments

Comments
 (0)