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

docs(python): Update plot docs to refer to docstrings #17504

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

henryharbeck
Copy link
Contributor

Closes #17503

Have aligned these files with py-polars/docs/source/reference/dataframe/style.rst, so hopefully it should work the same. Leaving as draft so I can build the docs locally and double check.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jul 8, 2024
@henryharbeck henryharbeck marked this pull request as ready for review July 15, 2024 13:19
@MarcoGorelli
Copy link
Collaborator

thanks @henryharbeck

Have aligned these files with py-polars/docs/source/reference/dataframe/style.rst, so hopefully it should work the same. Leaving as draft so I can build the docs locally and double check.

I presume you did this and that it works as intended?

@henryharbeck
Copy link
Contributor Author

Hi @MarcoGorelli - yes I did.
Thanks for confirming - apologies, I should've updated the PR description.

For Series.plot, I used the autoproperty directive instead of autoaccessorattribute (which all the other Series attributes use), as it displays the return type. Useful I figured particularly when it is not a Polars type.

image

Copy link
Collaborator

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good one @henryharbeck

@MarcoGorelli MarcoGorelli merged commit 7a4a9d0 into pola-rs:main Jul 15, 2024
12 checks passed
@henryharbeck henryharbeck deleted the plot-docs branch July 15, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

plot docs not displaying completely
2 participants