Skip to content

DOC: repurpose Styler as a general display tool and not an HTML-CSS tool #47830

Open
@attack68

Description

@attack68

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/pandas-docs/dev/user_guide/style.html

Documentation problem

When Styler was originally designed and released, its aim was to display HTML in a Jupyter Notebook, that could be manipulated and conditionally formatted. The user guide and documentation over the years has therefore focused on the HTML side of things, and the more recent display and general formatting features are seen as extras to suit that environment, and patchwork included in the documentation.

This issue probably targets pandas 2.0 where I am suggesting that the Table Visualization part of the user guide pushes Styler as a generalist DataFrame formatter, describing the generic functionality it has, and also expanding the conditional aspects which can now be output to HTML, LaTeX and Excel.

My philosophy with the development I put into Styler was for it to be;

  • First and foremost a formatting tool to display data in any way the user wants, without changing the underlying data, with outputs to String (i.e. CSV), HTML, LaTeX, Excel, and (ultimately) JSON.
  • Provide extra conditional formatting features that suit the environment, e.g. HTML-CSS, LaTeX commands, Excel colors, etc.

Any comments welcome, but I think moving forward having a variety of easily accessible, configurable display representations is a great tool for data science.

Comments very welcome.

Suggested fix for documentation

.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsStylerconditional formatting using DataFrame.style

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions