Skip to content

DOC: Missing documentation for Styler.columns and Styler.index #60815

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
1 task done
Dr-Irv opened this issue Jan 29, 2025 · 5 comments · Fixed by #60979
Closed
1 task done

DOC: Missing documentation for Styler.columns and Styler.index #60815

Dr-Irv opened this issue Jan 29, 2025 · 5 comments · Fixed by #60979
Assignees
Labels
Docs Styler conditional formatting using DataFrame.style

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Jan 29, 2025

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/api/pandas.io.formats.style.Styler.html#pandas.io.formats.style.Styler

Documentation problem

The attributes columns and index are not documented for the Styler class.

Suggested fix for documentation

Document those attributes.

Initially reported here in pandas-stubs : pandas-dev/pandas-stubs#1102

@Dr-Irv Dr-Irv added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 29, 2025
@rhshadrach
Copy link
Member

cc @attack68 for awareness.

@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 4, 2025
@Rishab260
Copy link
Contributor

take

@Rishab260
Copy link
Contributor

Rishab260 commented Feb 15, 2025

I noticed that data is used to instantiate Styler, as seen in the Styler constructor. Since columns and index are derived from data, it seems more appropriate to document them under Attributes rather than listing them as parameters.

Would love to hear your thoughts on this! @Dr-Irv @rhshadrach

@Dr-Irv
Copy link
Contributor Author

Dr-Irv commented Feb 18, 2025

I noticed that data is used to instantiate Styler, as seen in the Styler constructor. Since columns and index are derived from data, it seems more appropriate to document them under Attributes rather than listing them as parameters.

Yes, that seems like the right thing to do.

@Rishab260
Copy link
Contributor

Okay, will be making the necessary changes. Thanks for your feedback @Dr-Irv

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.

3 participants