Skip to content

Commit 50e19fd

Browse files
dayorekeNico Cernek
authored and
Nico Cernek
committed
DOC: Fixed doctring errors PR08, PR09 in pandas.io (pandas-dev#28748)
1 parent 3ccbc92 commit 50e19fd

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

pandas/io/formats/style.py

+31-31
Original file line numberDiff line numberDiff line change
@@ -642,16 +642,16 @@ def apply(self, func, axis=0, subset=None, **kwargs):
642642
``func`` should take a Series or DataFrame (depending
643643
on ``axis``), and return an object with the same shape.
644644
Must return a DataFrame with identical index and
645-
column labels when ``axis=None``
645+
column labels when ``axis=None``.
646646
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
648648
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
649649
with ``axis=None``.
650650
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.
653653
**kwargs : dict
654-
pass along to ``func``
654+
Pass along to ``func``.
655655
656656
Returns
657657
-------
@@ -698,12 +698,12 @@ def applymap(self, func, subset=None, **kwargs):
698698
Parameters
699699
----------
700700
func : function
701-
``func`` should take a scalar and return a scalar
701+
``func`` should take a scalar and return a scalar.
702702
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.
705705
**kwargs : dict
706-
pass along to ``func``
706+
Pass along to ``func``.
707707
708708
Returns
709709
-------
@@ -729,16 +729,16 @@ def where(self, cond, value, other=None, subset=None, **kwargs):
729729
Parameters
730730
----------
731731
cond : callable
732-
``cond`` should take a scalar and return a boolean
732+
``cond`` should take a scalar and return a boolean.
733733
value : str
734-
applied when ``cond`` returns true
734+
Applied when ``cond`` returns true.
735735
other : str
736-
applied when ``cond`` returns false
736+
Applied when ``cond`` returns false.
737737
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.
740740
**kwargs : dict
741-
pass along to ``cond``
741+
Pass along to ``cond``.
742742
743743
Returns
744744
-------
@@ -819,7 +819,7 @@ def use(self, styles):
819819
Parameters
820820
----------
821821
styles : list
822-
list of style functions
822+
List of style functions.
823823
824824
Returns
825825
-------
@@ -969,19 +969,19 @@ def background_gradient(
969969
Parameters
970970
----------
971971
cmap : str or colormap
972-
matplotlib colormap
972+
Matplotlib colormap.
973973
low : float
974-
compress the range by the low.
974+
Compress the range by the low.
975975
high : float
976-
compress the range by the high.
976+
Compress the range by the high.
977977
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
979979
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
980980
with ``axis=None``.
981981
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.
983983
text_color_threshold : float or int
984-
luminance threshold for determining text color. Facilitates text
984+
Luminance threshold for determining text color. Facilitates text
985985
visibility across varying background colors. From 0 to 1.
986986
0 = all text is dark colored, 1 = all text is light colored.
987987
@@ -1084,9 +1084,9 @@ def set_properties(self, subset=None, **kwargs):
10841084
Parameters
10851085
----------
10861086
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.
10881088
**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.
10901090
10911091
Returns
10921092
-------
@@ -1180,7 +1180,7 @@ def bar(
11801180
subset : IndexSlice, optional
11811181
A valid slice for `data` to limit the style application to.
11821182
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
11841184
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
11851185
with ``axis=None``.
11861186
color : str or 2-tuple/list
@@ -1256,10 +1256,10 @@ def highlight_max(self, subset=None, color="yellow", axis=0):
12561256
Parameters
12571257
----------
12581258
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.
12601260
color : str, default 'yellow'
12611261
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
12631263
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
12641264
with ``axis=None``.
12651265
@@ -1276,10 +1276,10 @@ def highlight_min(self, subset=None, color="yellow", axis=0):
12761276
Parameters
12771277
----------
12781278
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.
12801280
color : str, default 'yellow'
12811281
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
12831283
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
12841284
with ``axis=None``.
12851285
@@ -1328,9 +1328,9 @@ def from_custom_template(cls, searchpath, name):
13281328
Parameters
13291329
----------
13301330
searchpath : str or list
1331-
Path or paths of directories containing the templates
1331+
Path or paths of directories containing the templates.
13321332
name : str
1333-
Name of your custom template to use for rendering
1333+
Name of your custom template to use for rendering.
13341334
13351335
Returns
13361336
-------

pandas/io/json/_table_schema.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ def build_table_schema(data, index=True, primary_key=None, version=True):
199199
index : bool, default True
200200
Whether to include ``data.index`` in the schema.
201201
primary_key : bool or None, default True
202-
column names to designate as the primary key.
202+
Column names to designate as the primary key.
203203
The default `None` will set `'primaryKey'` to the index
204204
level or levels if the index is unique.
205205
version : bool, default True

0 commit comments

Comments
 (0)