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): Alphabetise methods in Python API reference #18380

Merged
merged 2 commits into from
Aug 27, 2024

Conversation

henryharbeck
Copy link
Contributor

@henryharbeck henryharbeck commented Aug 26, 2024

It is evident based on the existing API reference that the methods are intended to be in alphabetical order (and they mostly are).

This does the remainder.

Note that there were a few exceptions where I decided alphabetical order was not better. strip_chars_end coming after strip_chars_start being one example. Let me know if you have a difference of opinion.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Aug 26, 2024
@@ -19,8 +19,8 @@ This page gives an overview of all public Series methods.
export
list
modify_select
Copy link
Contributor Author

Choose a reason for hiding this comment

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

modify_select appears in the docs as Manipulation/selection, so is correctly before miscellaneous

Returns the standard deviation of all the elements in the grouping.
Returns the sample standard deviation of all the elements in the grouping.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

drive by

@mcrumiller
Copy link
Contributor

Any way to add sorting to pre-commit?

@ritchie46
Copy link
Member

Thanks @henryharbeck

@ritchie46 ritchie46 merged commit 6269126 into pola-rs:main Aug 27, 2024
13 checks passed
@henryharbeck henryharbeck deleted the alphabetise branch August 27, 2024 07:15
@henryharbeck
Copy link
Contributor Author

@mcrumiller

Any way to add sorting to pre-commit?

Good idea - will see if I can do something with a small footprint

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.

3 participants