Skip to content

Documentation doesn't match function: highlight_min, highlight_max #16998

@parchd-1

Description

@parchd-1

The docstring for highlight_min and highlight_max state that applying tablewise is the default, but the function signatures set the default to axis 0.

 def highlight_min(self, subset=None, color='yellow', axis=0): """  Highlight the minimum by shading the background  .. versionadded:: 0.17.1  Parameters  ----------  subset: IndexSlice, default None  a valid slice for ``data`` to limit the style application to  color: str, default 'yellow'  axis: int, str, or None; default None  0 or 'index' for columnwise, 1 or 'columns' for rowwise  or ``None`` for tablewise (the default)  Returns  -------  self : Styler  """ return self._highlight_handler(subset=subset, color=color, axis=axis, max_=False)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions