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): Add missing Series methods to API reference #18312

Merged
merged 2 commits into from
Aug 22, 2024

Conversation

henryharbeck
Copy link
Contributor

Closes #17786

Missing doc items identified by looking at any methods without links here. Have validated that all works as expected against a local docs build.

Also note that Series does not implement many of the operator methods offered on DataFrame.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Aug 22, 2024
@@ -19,6 +19,7 @@ Computation
Series.cos
Series.cosh
Series.cot
Series.count
Copy link
Collaborator

Choose a reason for hiding this comment

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

would aggregation be a better section, as that's where it is for Expr?

Copy link
Contributor Author

@henryharbeck henryharbeck Aug 22, 2024

Choose a reason for hiding this comment

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

Thanks for the question and the quick review. Yes, I do think that's a better section - thanks for that.

It is in both aggregation and functions for Expr, so initially that was why I added it into computation. Upon reflection aggregation is indeed much better suited. Will update now.

Copy link
Collaborator

Choose a reason for hiding this comment

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

oh it's in both for Expr? 🤔 maybe the functions one can be removed then?

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.

Nice one, thanks @henryharbeck !

If you the wanted to de-dupe Expr.count (remove it from "functions"?) I think that'd be good too - is it the only one that's duplicated or are there others?

@MarcoGorelli MarcoGorelli merged commit 9ceaad4 into pola-rs:main Aug 22, 2024
11 checks passed
@MarcoGorelli
Copy link
Collaborator

If you the wanted to de-dupe Expr.count (remove it from "functions"?) I think that'd be good too - is it the only one that's duplicated or are there others?

edit: i asked about this, and devs are ok with some being in multiple places, so no need to change that for expr

@henryharbeck
Copy link
Contributor Author

Thanks again @MarcoGorelli! 😃
Apologies to disappear after you replied to me 1 minute later 😅, was getting late and then had a busy weekend

@henryharbeck henryharbeck deleted the series-docs branch August 26, 2024 12:20
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.

Missing docs pages for some Series methods
2 participants