Skip to content

DOC: Enhance docs for Styler: details and high level. #39593

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
attack68 opened this issue Feb 4, 2021 · 1 comment · Fixed by #39720
Closed

DOC: Enhance docs for Styler: details and high level. #39593

attack68 opened this issue Feb 4, 2021 · 1 comment · Fixed by #39720
Labels
Docs Styler conditional formatting using DataFrame.style
Milestone

Comments

@attack68
Copy link
Contributor

attack68 commented Feb 4, 2021

Location of the documentation

ecosystem, + user_guide/index.rst + style.ipynb + visualization.rst
possibly others.

Documentation problem and proposed changes.

High Level

Scientific data visualization is not just restricted to charting. Tabular data visualization is important and Styler has some really good features for dealing with this - albeit Styler is not a recognised scientific term.

Currently the User Guide has left navigation links Visualization and Styling, and I would like to rename them Chart Visualization and Table Visualization and put them next to each other in the list. Also with some cross-refs.
The Api page has a Style navigation link which is probably best left as is due to API naming.

Low Level

a) I will revisit the style.ipynb page and update it with many of the new features, and possibly provide more of a continuous real-case example, rather than using numpy.random repeatedly to demonstrate the features. This isn't completely necessary but maybe works well.

b) I will revisit the function doc strings to ensure consistency on the API page (there is some inconsistency currently) and add examples where missing to the API page.



If you feel this is warranted or have any comments on the items please share before I get started.

@attack68 attack68 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Feb 4, 2021
@jreback
Copy link
Contributor

jreback commented Feb 4, 2021

sounds reasonable

note that we can do redirects for new page names (see conf.py)

@rhshadrach rhshadrach removed the Needs Triage Issue that has not been reviewed by a pandas team member label Feb 4, 2021
@attack68 attack68 added the Styler conditional formatting using DataFrame.style label Feb 10, 2021
@lithomas1 lithomas1 added this to the 1.3 milestone Feb 11, 2021
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
Development

Successfully merging a pull request may close this issue.

4 participants