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

Merged
merged 2 commits into from
Aug 22, 2024
Merged

docs(python): Add missing Series methods to API reference #18312

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ee3130
add missing series methods
Aug 22, 2024
10f8a58
move count into `aggregation` page
Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions py-polars/docs/source/reference/series/computation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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?

Series.cum_count
Series.cum_max
Series.cum_min
Expand Down
1 change: 1 addition & 0 deletions py-polars/docs/source/reference/series/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This page gives an overview of all public Series methods.
export
list
modify_select
operators
miscellaneous
plot
string
Expand Down
31 changes: 31 additions & 0 deletions py-polars/docs/source/reference/series/operators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
=========
Operators
=========

Polars supports native Python operators for all common operations;
many of these operators are also available as methods on the :class:`Series`
class.

Comparison
~~~~~~~~~~

.. currentmodule:: polars
.. autosummary::
:toctree: api/

Series.eq
Series.eq_missing
Series.ge
Series.gt
Series.le
Series.lt
Series.ne
Series.ne_missing

Numeric
~~~~~~~

.. autosummary::
:toctree: api/

Series.pow