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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/aggregation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Aggregation

Series.arg_max
Series.arg_min
Series.count
Series.implode
Series.max
Series.mean
Expand Down
1 change: 1 addition & 0 deletions py-polars/docs/source/reference/series/index.rst
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
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