Skip to content
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

DOC: Missing documentation for pandas styler properties #60872

Open
1 task done
star1327p opened this issue Feb 7, 2025 · 12 comments
Open
1 task done

DOC: Missing documentation for pandas styler properties #60872

star1327p opened this issue Feb 7, 2025 · 12 comments
Assignees
Labels
Docs Styler conditional formatting using DataFrame.style

Comments

@star1327p
Copy link
Contributor

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/docs/dev/reference/style.html

Documentation problem

The whole section of pandas styler properties is blank. Related to Issue #60815.

Image

Suggested fix for documentation

Document each of the Styler properties listed on the page, or at least state that the section is still under development.

@star1327p star1327p added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Feb 7, 2025
@rhshadrach rhshadrach added Styler conditional formatting using DataFrame.style and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Feb 8, 2025
@Rishab260
Copy link
Contributor

take

@Rishab260
Copy link
Contributor

Hi @star1327p , I see some related issues here

so am I correct to assume that documenting these attributes should be first thing to do?

@star1327p
Copy link
Contributor Author

@Rishab260 Yes, I think so. Thank you for taking on this issue!

@Rishab260
Copy link
Contributor

Rishab260 commented Feb 23, 2025

Before:

Before

After:

Screenshot 2025-02-23 9 54 09 PM

@Rishab260
Copy link
Contributor

I am trying the following:-

Styler properties
-----------------
.. list-table::
   :widths: auto

   * - :attr:`Styler.index` : Index
     - Index of the DataFrame.
   * - :attr:`Styler.columns` : Index
     - Columns of the DataFrame.
   * - :attr:`Styler.env` : jinja2.Environment
     - Jinja2 Environment for template rendering.
   * - :attr:`Styler.template_html` : jinja2.Template
     - Jinja2 Template for rendering `Styler` objects as HTML output.
   * - :attr:`Styler.template_html_style` : jinja2.Template
     - Jinja2 Template for the `<style>` section in the HTML output.
   * - :attr:`Styler.template_html_table` : jinja2.Template
     - Jinja2 Template for rendering HTML tables.
   * - :attr:`Styler.template_latex` : jinja2.Template
     - Jinja2 Template for LaTeX output.
   * - :attr:`Styler.template_typst` : jinja2.Template
     - Jinja2 Template for Typst output.
   * - :attr:`Styler.template_string` : jinja2.Template
     - Jinja2 Template for string representation.
   * - :attr:`Styler.loader` : jinja2.BaseLoader
     - Jinja2 Loader for templates.

However, after building the documentation, I find it a little different from what I see at https://pandas.pydata.org/docs/dev/reference/style.html, the hyperlinks are gone for example and the colors are different.

@Rishab260
Copy link
Contributor

Hi, @Dr-Irv could you please take a look at this? It is related to
#60815
#60979

Regards
Rishab

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Mar 3, 2025

Hi, @Dr-Irv could you please take a look at this? It is related to

Not sure what you want me to look at, but https://pandas.pydata.org/docs/dev/reference/api/pandas.io.formats.style.Styler.html looks correct. Might need to also fix https://pandas.pydata.org/docs/dev/reference/style.html separately

@Rishab260
Copy link
Contributor

Rishab260 commented Mar 3, 2025

Hi, @Dr-Irv could you please take a look at this? It is related to

Not sure what you want me to look at, but https://pandas.pydata.org/docs/dev/reference/api/pandas.io.formats.style.Styler.html looks correct. Might need to also fix https://pandas.pydata.org/docs/dev/reference/style.html separately

SS

@Rishab260
Copy link
Contributor

The formatting does not match with what I can see at Style.html

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Mar 3, 2025

Hi, @Dr-Irv could you please take a look at this? It is related to

Not sure what you want me to look at, but https://pandas.pydata.org/docs/dev/reference/api/pandas.io.formats.style.Styler.html looks correct. Might need to also fix https://pandas.pydata.org/docs/dev/reference/style.html separately

SS

When I click on that link, I get "This private-user-images.githubusercontent.com page can’t be found"

@KevsterAmp
Copy link
Contributor

Hi @Rishab260, are you still working on this issue? If not, I'd be happy to take it over. Let me know—thanks!

@Rishab260
Copy link
Contributor

Hi @Rishab260, are you still working on this issue? If not, I'd be happy to take it over. Let me know—thanks!

Sure, go ahead

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

No branches or pull requests

5 participants