diff --git a/pandas/io/formats/style.py b/pandas/io/formats/style.py index c1af3f93f44eb..9c4746f4d68e3 100644 --- a/pandas/io/formats/style.py +++ b/pandas/io/formats/style.py @@ -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 ------- @@ -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 ------- @@ -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 ------- @@ -819,7 +819,7 @@ def use(self, styles): Parameters ---------- styles : list - list of style functions + List of style functions. Returns ------- @@ -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. @@ -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 ------- @@ -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 @@ -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``. @@ -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``. @@ -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 ------- diff --git a/pandas/io/json/_table_schema.py b/pandas/io/json/_table_schema.py index b142dbf76e6b3..9016e8a98e5ba 100644 --- a/pandas/io/json/_table_schema.py +++ b/pandas/io/json/_table_schema.py @@ -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