Skip to content

DOC: Fixed doctring errors PR08, PR09 in pandas.io #28748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions pandas/io/formats/style.py
Original file line number Diff line number Diff line change
Expand Up @@ -642,16 +642,16 @@ def apply(self, func, axis=0, subset=None, **kwargs):
``func`` should take a Series or DataFrame (depending
on ``axis``), and return an object with the same shape.
Must return a DataFrame with identical index and
column labels when ``axis=None``
column labels when ``axis=None``.
axis : {0 or 'index', 1 or 'columns', None}, default 0
apply to each column (``axis=0`` or ``'index'``), to each row
Apply to each column (``axis=0`` or ``'index'``), to each row
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
with ``axis=None``.
subset : IndexSlice
a valid indexer to limit ``data`` to *before* applying the
function. Consider using a pandas.IndexSlice
A valid indexer to limit ``data`` to *before* applying the
function. Consider using a pandas.IndexSlice.
**kwargs : dict
pass along to ``func``
Pass along to ``func``.

Returns
-------
Expand Down Expand Up @@ -698,12 +698,12 @@ def applymap(self, func, subset=None, **kwargs):
Parameters
----------
func : function
``func`` should take a scalar and return a scalar
``func`` should take a scalar and return a scalar.
subset : IndexSlice
a valid indexer to limit ``data`` to *before* applying the
function. Consider using a pandas.IndexSlice
A valid indexer to limit ``data`` to *before* applying the
function. Consider using a pandas.IndexSlice.
**kwargs : dict
pass along to ``func``
Pass along to ``func``.

Returns
-------
Expand All @@ -729,16 +729,16 @@ def where(self, cond, value, other=None, subset=None, **kwargs):
Parameters
----------
cond : callable
``cond`` should take a scalar and return a boolean
``cond`` should take a scalar and return a boolean.
value : str
applied when ``cond`` returns true
Applied when ``cond`` returns true.
other : str
applied when ``cond`` returns false
Applied when ``cond`` returns false.
subset : IndexSlice
a valid indexer to limit ``data`` to *before* applying the
function. Consider using a pandas.IndexSlice
A valid indexer to limit ``data`` to *before* applying the
function. Consider using a pandas.IndexSlice.
**kwargs : dict
pass along to ``cond``
Pass along to ``cond``.

Returns
-------
Expand Down Expand Up @@ -819,7 +819,7 @@ def use(self, styles):
Parameters
----------
styles : list
list of style functions
List of style functions.

Returns
-------
Expand Down Expand Up @@ -969,19 +969,19 @@ def background_gradient(
Parameters
----------
cmap : str or colormap
matplotlib colormap
Matplotlib colormap.
low : float
compress the range by the low.
Compress the range by the low.
high : float
compress the range by the high.
Compress the range by the high.
axis : {0 or 'index', 1 or 'columns', None}, default 0
apply to each column (``axis=0`` or ``'index'``), to each row
Apply to each column (``axis=0`` or ``'index'``), to each row
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
with ``axis=None``.
subset : IndexSlice
a valid slice for ``data`` to limit the style application to.
A valid slice for ``data`` to limit the style application to.
text_color_threshold : float or int
luminance threshold for determining text color. Facilitates text
Luminance threshold for determining text color. Facilitates text
visibility across varying background colors. From 0 to 1.
0 = all text is dark colored, 1 = all text is light colored.

Expand Down Expand Up @@ -1084,9 +1084,9 @@ def set_properties(self, subset=None, **kwargs):
Parameters
----------
subset : IndexSlice
a valid slice for ``data`` to limit the style application to
A valid slice for ``data`` to limit the style application to.
**kwargs : dict
property: value pairs to be set for each cell
A dictionary of property, value pairs to be set for each cell.

Returns
-------
Expand Down Expand Up @@ -1180,7 +1180,7 @@ def bar(
subset : IndexSlice, optional
A valid slice for `data` to limit the style application to.
axis : {0 or 'index', 1 or 'columns', None}, default 0
apply to each column (``axis=0`` or ``'index'``), to each row
Apply to each column (``axis=0`` or ``'index'``), to each row
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
with ``axis=None``.
color : str or 2-tuple/list
Expand Down Expand Up @@ -1256,10 +1256,10 @@ def highlight_max(self, subset=None, color="yellow", axis=0):
Parameters
----------
subset : IndexSlice, default None
a valid slice for ``data`` to limit the style application to.
A valid slice for ``data`` to limit the style application to.
color : str, default 'yellow'
axis : {0 or 'index', 1 or 'columns', None}, default 0
apply to each column (``axis=0`` or ``'index'``), to each row
Apply to each column (``axis=0`` or ``'index'``), to each row
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
with ``axis=None``.

Expand All @@ -1276,10 +1276,10 @@ def highlight_min(self, subset=None, color="yellow", axis=0):
Parameters
----------
subset : IndexSlice, default None
a valid slice for ``data`` to limit the style application to.
A valid slice for ``data`` to limit the style application to.
color : str, default 'yellow'
axis : {0 or 'index', 1 or 'columns', None}, default 0
apply to each column (``axis=0`` or ``'index'``), to each row
Apply to each column (``axis=0`` or ``'index'``), to each row
(``axis=1`` or ``'columns'``), or to the entire DataFrame at once
with ``axis=None``.

Expand Down Expand Up @@ -1328,9 +1328,9 @@ def from_custom_template(cls, searchpath, name):
Parameters
----------
searchpath : str or list
Path or paths of directories containing the templates
Path or paths of directories containing the templates.
name : str
Name of your custom template to use for rendering
Name of your custom template to use for rendering.

Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion pandas/io/json/_table_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def build_table_schema(data, index=True, primary_key=None, version=True):
index : bool, default True
Whether to include ``data.index`` in the schema.
primary_key : bool or None, default True
column names to designate as the primary key.
Column names to designate as the primary key.
The default `None` will set `'primaryKey'` to the index
level or levels if the index is unique.
version : bool, default True
Expand Down