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

Co-authored-by: Henry Harbeck <henry.harbeck@canstar.com.au>
pola-rs · Aug 22, 2024 · 9ceaad4 · 9ceaad4
1 parent a601ccf
commit 9ceaad4
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/py-polars/docs/source/reference/series/aggregation.rst b/py-polars/docs/source/reference/series/aggregation.rst
@@ -8,6 +8,7 @@ Aggregation
 
     Series.arg_max
     Series.arg_min
+    Series.count
     Series.implode
     Series.max
     Series.mean

diff --git a/py-polars/docs/source/reference/series/index.rst b/py-polars/docs/source/reference/series/index.rst
@@ -19,6 +19,7 @@ This page gives an overview of all public Series methods.
    export
    list
    modify_select
+   operators
    miscellaneous
    plot
    string

diff --git a/py-polars/docs/source/reference/series/operators.rst b/py-polars/docs/source/reference/series/operators.rst
@@ -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