Skip to content

Commit eaa94eb

Browse files
committed
Unify axis docstrings
1 parent bf2d569 commit eaa94eb

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

pandas/io/formats/style.py

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -894,9 +894,10 @@ def background_gradient(self, cmap='PuBu', low=0, high=0, axis=0,
894894
matplotlib colormap
895895
low, high : float
896896
compress the range by these values.
897-
axis : int or str
898-
0 or 'index' for columnwise, 1 or 'columns' for rowwise, or
899-
``None`` for tablewise
897+
axis : int, str or None
898+
apply to each column (``axis=0`` or ``'index'``) or to each row
899+
(``axis=1`` or ``'columns'``) or to the entire DataFrame at once
900+
with ``axis=None``.
900901
subset : IndexSlice
901902
a valid slice for ``data`` to limit the style application to
902903
text_color_threshold : float or int
@@ -1152,9 +1153,10 @@ def highlight_max(self, subset=None, color='yellow', axis=0):
11521153
subset : IndexSlice, default None
11531154
a valid slice for ``data`` to limit the style application to
11541155
color : str, default 'yellow'
1155-
axis : int, str, or None; default 0
1156-
0 or 'index' for columnwise (default), 1 or 'columns' for rowwise,
1157-
or ``None`` for tablewise
1156+
axis : int, str or None
1157+
apply to each column (``axis=0`` or ``'index'``) or to each row
1158+
(``axis=1`` or ``'columns'``) or to the entire DataFrame at once
1159+
with ``axis=None``.
11581160
11591161
Returns
11601162
-------
@@ -1172,9 +1174,10 @@ def highlight_min(self, subset=None, color='yellow', axis=0):
11721174
subset : IndexSlice, default None
11731175
a valid slice for ``data`` to limit the style application to
11741176
color : str, default 'yellow'
1175-
axis : int, str, or None; default 0
1176-
0 or 'index' for columnwise (default), 1 or 'columns' for rowwise,
1177-
or ``None`` for tablewise
1177+
axis : int, str or None
1178+
apply to each column (``axis=0`` or ``'index'``) or to each row
1179+
(``axis=1`` or ``'columns'``) or to the entire DataFrame at once
1180+
with ``axis=None``.
11781181
11791182
Returns
11801183
-------

0 commit comments

Comments
 (0)