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.

Sign up for GitHub

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

Jump to bottom

docs(python): Show return type for Series attributes in API reference #17759

Merged
merged 1 commit into from
Jul 23, 2024
Merged

docs(python): Show return type for Series attributes in API reference #17759

merged 1 commit into from
Jul 23, 2024

Conversation

henryharbeck
Copy link
Contributor

Closes #17640

Example before
image

Example after (consistent with DataFrame and LazyFrame docs)
image

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jul 21, 2024
@ritchie46
Copy link
Member

Nice. Just to be sure, it doesn't break anything by removing that?

@henryharbeck
Copy link
Contributor Author

All other docs pages still look as normal. Snippets of local docs build below.

No need for the autosummary/accessor_attribute.rst as these are just plain attributes. The file is now consistent with the DataFrame and LazyFrame attributes files.

Series Attributes page
image

Series page
image

Search page
image

@ritchie46
Copy link
Member

Alright! Thanks!

@ritchie46 ritchie46 merged commit bdd5076 into pola-rs:main Jul 23, 2024
12 checks passed
atigbadr pushed a commit to atigbadr/polars that referenced this pull request Jul 23, 2024
@henryharbeck @atigbadr
docs(python): Show return type for Series attributes in API reference (…
c026d93 
…pola-rs#17759)

Co-authored-by: Henry Harbeck <[email protected]>
@henryharbeck henryharbeck deleted the series-attributes branch July 23, 2024 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@c-peters c-peters Awaiting requested review from c-peters c-peters is a code owner

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@MarcoGorelli MarcoGorelli Awaiting requested review from MarcoGorelli MarcoGorelli is a code owner

@reswqa reswqa Awaiting requested review from reswqa reswqa is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Show return type for Series attributes in API reference
2 participants
@henryharbeck @ritchie46