@@ -642,16 +642,16 @@ def apply(self, func, axis=0, subset=None, **kwargs):
642
642
``func`` should take a Series or DataFrame (depending
643
643
on ``axis``), and return an object with the same shape.
644
644
Must return a DataFrame with identical index and
645
- column labels when ``axis=None``
645
+ column labels when ``axis=None``.
646
646
axis : {0 or 'index', 1 or 'columns', None}, default 0
647
- apply to each column (``axis=0`` or ``'index'``), to each row
647
+ Apply to each column (``axis=0`` or ``'index'``), to each row
648
648
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
649
649
with ``axis=None``.
650
650
subset : IndexSlice
651
- a valid indexer to limit ``data`` to *before* applying the
652
- function. Consider using a pandas.IndexSlice
651
+ A valid indexer to limit ``data`` to *before* applying the
652
+ function. Consider using a pandas.IndexSlice.
653
653
**kwargs : dict
654
- pass along to ``func``
654
+ Pass along to ``func``.
655
655
656
656
Returns
657
657
-------
@@ -698,12 +698,12 @@ def applymap(self, func, subset=None, **kwargs):
698
698
Parameters
699
699
----------
700
700
func : function
701
- ``func`` should take a scalar and return a scalar
701
+ ``func`` should take a scalar and return a scalar.
702
702
subset : IndexSlice
703
- a valid indexer to limit ``data`` to *before* applying the
704
- function. Consider using a pandas.IndexSlice
703
+ A valid indexer to limit ``data`` to *before* applying the
704
+ function. Consider using a pandas.IndexSlice.
705
705
**kwargs : dict
706
- pass along to ``func``
706
+ Pass along to ``func``.
707
707
708
708
Returns
709
709
-------
@@ -729,16 +729,16 @@ def where(self, cond, value, other=None, subset=None, **kwargs):
729
729
Parameters
730
730
----------
731
731
cond : callable
732
- ``cond`` should take a scalar and return a boolean
732
+ ``cond`` should take a scalar and return a boolean.
733
733
value : str
734
- applied when ``cond`` returns true
734
+ Applied when ``cond`` returns true.
735
735
other : str
736
- applied when ``cond`` returns false
736
+ Applied when ``cond`` returns false.
737
737
subset : IndexSlice
738
- a valid indexer to limit ``data`` to *before* applying the
739
- function. Consider using a pandas.IndexSlice
738
+ A valid indexer to limit ``data`` to *before* applying the
739
+ function. Consider using a pandas.IndexSlice.
740
740
**kwargs : dict
741
- pass along to ``cond``
741
+ Pass along to ``cond``.
742
742
743
743
Returns
744
744
-------
@@ -819,7 +819,7 @@ def use(self, styles):
819
819
Parameters
820
820
----------
821
821
styles : list
822
- list of style functions
822
+ List of style functions.
823
823
824
824
Returns
825
825
-------
@@ -969,19 +969,19 @@ def background_gradient(
969
969
Parameters
970
970
----------
971
971
cmap : str or colormap
972
- matplotlib colormap
972
+ Matplotlib colormap.
973
973
low : float
974
- compress the range by the low.
974
+ Compress the range by the low.
975
975
high : float
976
- compress the range by the high.
976
+ Compress the range by the high.
977
977
axis : {0 or 'index', 1 or 'columns', None}, default 0
978
- apply to each column (``axis=0`` or ``'index'``), to each row
978
+ Apply to each column (``axis=0`` or ``'index'``), to each row
979
979
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
980
980
with ``axis=None``.
981
981
subset : IndexSlice
982
- a valid slice for ``data`` to limit the style application to.
982
+ A valid slice for ``data`` to limit the style application to.
983
983
text_color_threshold : float or int
984
- luminance threshold for determining text color. Facilitates text
984
+ Luminance threshold for determining text color. Facilitates text
985
985
visibility across varying background colors. From 0 to 1.
986
986
0 = all text is dark colored, 1 = all text is light colored.
987
987
@@ -1084,9 +1084,9 @@ def set_properties(self, subset=None, **kwargs):
1084
1084
Parameters
1085
1085
----------
1086
1086
subset : IndexSlice
1087
- a valid slice for ``data`` to limit the style application to
1087
+ A valid slice for ``data`` to limit the style application to.
1088
1088
**kwargs : dict
1089
- property: value pairs to be set for each cell
1089
+ A dictionary of property, value pairs to be set for each cell.
1090
1090
1091
1091
Returns
1092
1092
-------
@@ -1180,7 +1180,7 @@ def bar(
1180
1180
subset : IndexSlice, optional
1181
1181
A valid slice for `data` to limit the style application to.
1182
1182
axis : {0 or 'index', 1 or 'columns', None}, default 0
1183
- apply to each column (``axis=0`` or ``'index'``), to each row
1183
+ Apply to each column (``axis=0`` or ``'index'``), to each row
1184
1184
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
1185
1185
with ``axis=None``.
1186
1186
color : str or 2-tuple/list
@@ -1256,10 +1256,10 @@ def highlight_max(self, subset=None, color="yellow", axis=0):
1256
1256
Parameters
1257
1257
----------
1258
1258
subset : IndexSlice, default None
1259
- a valid slice for ``data`` to limit the style application to.
1259
+ A valid slice for ``data`` to limit the style application to.
1260
1260
color : str, default 'yellow'
1261
1261
axis : {0 or 'index', 1 or 'columns', None}, default 0
1262
- apply to each column (``axis=0`` or ``'index'``), to each row
1262
+ Apply to each column (``axis=0`` or ``'index'``), to each row
1263
1263
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
1264
1264
with ``axis=None``.
1265
1265
@@ -1276,10 +1276,10 @@ def highlight_min(self, subset=None, color="yellow", axis=0):
1276
1276
Parameters
1277
1277
----------
1278
1278
subset : IndexSlice, default None
1279
- a valid slice for ``data`` to limit the style application to.
1279
+ A valid slice for ``data`` to limit the style application to.
1280
1280
color : str, default 'yellow'
1281
1281
axis : {0 or 'index', 1 or 'columns', None}, default 0
1282
- apply to each column (``axis=0`` or ``'index'``), to each row
1282
+ Apply to each column (``axis=0`` or ``'index'``), to each row
1283
1283
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
1284
1284
with ``axis=None``.
1285
1285
@@ -1328,9 +1328,9 @@ def from_custom_template(cls, searchpath, name):
1328
1328
Parameters
1329
1329
----------
1330
1330
searchpath : str or list
1331
- Path or paths of directories containing the templates
1331
+ Path or paths of directories containing the templates.
1332
1332
name : str
1333
- Name of your custom template to use for rendering
1333
+ Name of your custom template to use for rendering.
1334
1334
1335
1335
Returns
1336
1336
-------
0 commit comments