Skip to content

DOC: Styling guide lacks links to the referenced objects #40645

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

Closed
moi90 opened this issue Mar 26, 2021 · 3 comments · Fixed by #39720
Closed

DOC: Styling guide lacks links to the referenced objects #40645

moi90 opened this issue Mar 26, 2021 · 3 comments · Fixed by #39720
Labels
Docs Styler conditional formatting using DataFrame.style
Milestone

Comments

@moi90
Copy link
Contributor

moi90 commented Mar 26, 2021

Location of the documentation

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

Documentation problem

The page lacks links to the referenced objects (DataFrame, Series, ... but most importantly Styler).

Suggested fix for documentation

Links should be included. This could either be done using raw reST cells (which looks not as nice in the downloadable notebook) or by inserting relative links into the markdown code (which breaks easily).

@moi90 moi90 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 26, 2021
@moi90 moi90 changed the title DOC: DOC: Styling guide lacks links to the referenced objects Mar 26, 2021
@attack68
Copy link
Contributor

does #39720 address some of these items?

@attack68
Copy link
Contributor

It creates links in the jupyter notebook that sphinx can parse. Such as:

Styling should be performed after the data in a DataFrame has been processed. 
The [Styler][styler] creates an HTML `<table>` and leverages CSS styling language to
 manipulate many parameters including colors, fonts, borders, background, etc. 
See [here][w3schools] for more information on styling HTML tables.
 This allows a lot of flexibility out of the box, and even enables web developers to 
integrate DataFrames into their exiting user interface designs.

The `DataFrame.style` attribute is a property that returns a [Styler][styler] object.
It has a `_repr_html_` method defined on it so they are rendered automatically in Jupyter Notebook.

[styler]: ../reference/api/pandas.io.formats.style.Styler.rst
[w3schools]: https://www.w3schools.com/html/html_tables.asp

@attack68 attack68 added Styler conditional formatting using DataFrame.style and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 26, 2021
@moi90
Copy link
Contributor Author

moi90 commented Mar 26, 2021

@attack68 Yes, I think #39720 resolves this issue. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Styler conditional formatting using DataFrame.style
Projects
None yet
3 participants