From 626912676f45dfeb437b26983802f3ebd3dc8ad6 Mon Sep 17 00:00:00 2001 From: Henry Harbeck <59268910+henryharbeck@users.noreply.github.com> Date: Tue, 27 Aug 2024 17:12:34 +1000 Subject: [PATCH] docs(python): Alphabetise methods in Python API reference (#18380) Co-authored-by: Henry Harbeck --- .../source/reference/expressions/array.rst | 36 +++++++++---------- .../reference/expressions/functions.rst | 6 ++-- .../source/reference/expressions/list.rst | 6 ++-- .../source/reference/expressions/name.rst | 6 ++-- .../reference/expressions/operators.rst | 2 +- .../source/reference/expressions/string.rst | 2 +- .../docs/source/reference/lazyframe/index.rst | 2 +- .../docs/source/reference/series/array.rst | 36 +++++++++---------- .../source/reference/series/attributes.rst | 2 +- .../docs/source/reference/series/export.rst | 2 +- .../docs/source/reference/series/index.rst | 2 +- .../docs/source/reference/series/list.rst | 6 ++-- .../source/reference/series/miscellaneous.rst | 2 +- .../reference/sql/functions/aggregate.rst | 2 +- 14 files changed, 56 insertions(+), 56 deletions(-) diff --git a/py-polars/docs/source/reference/expressions/array.rst b/py-polars/docs/source/reference/expressions/array.rst index f25f2a30bbfd..1573c478920c 100644 --- a/py-polars/docs/source/reference/expressions/array.rst +++ b/py-polars/docs/source/reference/expressions/array.rst @@ -9,27 +9,27 @@ The following methods are available under the `expr.arr` attribute. :toctree: api/ :template: autosummary/accessor_method.rst - Expr.arr.max - Expr.arr.min - Expr.arr.median - Expr.arr.sum - Expr.arr.std - Expr.arr.to_list - Expr.arr.unique - Expr.arr.n_unique - Expr.arr.var Expr.arr.all Expr.arr.any - Expr.arr.sort - Expr.arr.reverse - Expr.arr.arg_min Expr.arr.arg_max - Expr.arr.get - Expr.arr.first - Expr.arr.last - Expr.arr.join - Expr.arr.explode + Expr.arr.arg_min Expr.arr.contains Expr.arr.count_matches - Expr.arr.to_struct + Expr.arr.explode + Expr.arr.first + Expr.arr.get + Expr.arr.join + Expr.arr.last + Expr.arr.max + Expr.arr.median + Expr.arr.min + Expr.arr.n_unique + Expr.arr.reverse Expr.arr.shift + Expr.arr.sort + Expr.arr.std + Expr.arr.sum + Expr.arr.to_list + Expr.arr.to_struct + Expr.arr.unique + Expr.arr.var diff --git a/py-polars/docs/source/reference/expressions/functions.rst b/py-polars/docs/source/reference/expressions/functions.rst index 9831d07cb803..b27fa4e87f84 100644 --- a/py-polars/docs/source/reference/expressions/functions.rst +++ b/py-polars/docs/source/reference/expressions/functions.rst @@ -35,9 +35,9 @@ These functions are available from the Polars module root and can be used as exp cum_sum cum_sum_horizontal date - datetime date_range date_ranges + datetime datetime_range datetime_ranges duration @@ -73,12 +73,12 @@ These functions are available from the Polars module root and can be used as exp rolling_corr rolling_cov select + sql + sql_expr std struct sum sum_horizontal - sql - sql_expr tail time time_range diff --git a/py-polars/docs/source/reference/expressions/list.rst b/py-polars/docs/source/reference/expressions/list.rst index 7d330772511d..18b9dd9c4867 100644 --- a/py-polars/docs/source/reference/expressions/list.rst +++ b/py-polars/docs/source/reference/expressions/list.rst @@ -11,17 +11,18 @@ The following methods are available under the `expr.list` attribute. Expr.list.all Expr.list.any - Expr.list.drop_nulls Expr.list.arg_max Expr.list.arg_min Expr.list.concat Expr.list.contains Expr.list.count_matches Expr.list.diff + Expr.list.drop_nulls Expr.list.eval Expr.list.explode Expr.list.first Expr.list.gather + Expr.list.gather_every Expr.list.get Expr.list.head Expr.list.join @@ -31,6 +32,7 @@ The following methods are available under the `expr.list` attribute. Expr.list.mean Expr.list.median Expr.list.min + Expr.list.n_unique Expr.list.reverse Expr.list.sample Expr.list.set_difference @@ -46,6 +48,4 @@ The following methods are available under the `expr.list` attribute. Expr.list.to_array Expr.list.to_struct Expr.list.unique - Expr.list.n_unique Expr.list.var - Expr.list.gather_every diff --git a/py-polars/docs/source/reference/expressions/name.rst b/py-polars/docs/source/reference/expressions/name.rst index c687651d6278..80693496c350 100644 --- a/py-polars/docs/source/reference/expressions/name.rst +++ b/py-polars/docs/source/reference/expressions/name.rst @@ -11,10 +11,10 @@ The following methods are available under the `expr.name` attribute. Expr.name.keep Expr.name.map + Expr.name.map_fields Expr.name.prefix + Expr.name.prefix_fields Expr.name.suffix + Expr.name.suffix_fields Expr.name.to_lowercase Expr.name.to_uppercase - Expr.name.map_fields - Expr.name.prefix_fields - Expr.name.suffix_fields diff --git a/py-polars/docs/source/reference/expressions/operators.rst b/py-polars/docs/source/reference/expressions/operators.rst index 397a0998a4a4..c4ce55a2b144 100644 --- a/py-polars/docs/source/reference/expressions/operators.rst +++ b/py-polars/docs/source/reference/expressions/operators.rst @@ -42,9 +42,9 @@ Numeric Expr.mod Expr.mul Expr.neg + Expr.pow Expr.sub Expr.truediv - Expr.pow Binary diff --git a/py-polars/docs/source/reference/expressions/string.rst b/py-polars/docs/source/reference/expressions/string.rst index 659cd0dbe40c..a0cde717f0da 100644 --- a/py-polars/docs/source/reference/expressions/string.rst +++ b/py-polars/docs/source/reference/expressions/string.rst @@ -51,7 +51,7 @@ The following methods are available under the `expr.str` attribute. Expr.str.to_decimal Expr.str.to_integer Expr.str.to_lowercase - Expr.str.to_titlecase Expr.str.to_time + Expr.str.to_titlecase Expr.str.to_uppercase Expr.str.zfill diff --git a/py-polars/docs/source/reference/lazyframe/index.rst b/py-polars/docs/source/reference/lazyframe/index.rst index 889437cb8fb9..fe0ea51e60ee 100644 --- a/py-polars/docs/source/reference/lazyframe/index.rst +++ b/py-polars/docs/source/reference/lazyframe/index.rst @@ -11,9 +11,9 @@ This page gives an overview of all public LazyFrame methods. aggregation attributes descriptive + group_by modify_select miscellaneous - group_by in_process .. _lazyframe: diff --git a/py-polars/docs/source/reference/series/array.rst b/py-polars/docs/source/reference/series/array.rst index 28976e1cab7d..92effb371544 100644 --- a/py-polars/docs/source/reference/series/array.rst +++ b/py-polars/docs/source/reference/series/array.rst @@ -9,27 +9,27 @@ The following methods are available under the `Series.arr` attribute. :toctree: api/ :template: autosummary/accessor_method.rst - Series.arr.max - Series.arr.min - Series.arr.median - Series.arr.sum - Series.arr.std - Series.arr.to_list - Series.arr.unique - Series.arr.n_unique - Series.arr.var Series.arr.all Series.arr.any - Series.arr.sort - Series.arr.reverse - Series.arr.arg_min Series.arr.arg_max - Series.arr.get - Series.arr.first - Series.arr.last - Series.arr.join - Series.arr.explode + Series.arr.arg_min Series.arr.contains Series.arr.count_matches + Series.arr.explode + Series.arr.first + Series.arr.get + Series.arr.join + Series.arr.last + Series.arr.max + Series.arr.median + Series.arr.min + Series.arr.n_unique + Series.arr.reverse + Series.arr.shift + Series.arr.sort + Series.arr.std + Series.arr.sum + Series.arr.to_list Series.arr.to_struct - Series.arr.shift \ No newline at end of file + Series.arr.unique + Series.arr.var diff --git a/py-polars/docs/source/reference/series/attributes.rst b/py-polars/docs/source/reference/series/attributes.rst index 50000e43edc7..2e2deb52f890 100644 --- a/py-polars/docs/source/reference/series/attributes.rst +++ b/py-polars/docs/source/reference/series/attributes.rst @@ -7,6 +7,6 @@ Attributes :toctree: api/ Series.dtype + Series.flags Series.name Series.shape - Series.flags diff --git a/py-polars/docs/source/reference/series/export.rst b/py-polars/docs/source/reference/series/export.rst index 06201adc2b1f..268ef25113fd 100644 --- a/py-polars/docs/source/reference/series/export.rst +++ b/py-polars/docs/source/reference/series/export.rst @@ -12,9 +12,9 @@ Export Series data to other formats: Series.__arrow_c_stream__ Series.to_arrow Series.to_frame + Series.to_init_repr Series.to_jax Series.to_list Series.to_numpy Series.to_pandas - Series.to_init_repr Series.to_torch diff --git a/py-polars/docs/source/reference/series/index.rst b/py-polars/docs/source/reference/series/index.rst index 5e054f4a2366..d507312498c9 100644 --- a/py-polars/docs/source/reference/series/index.rst +++ b/py-polars/docs/source/reference/series/index.rst @@ -19,8 +19,8 @@ This page gives an overview of all public Series methods. export list modify_select - operators miscellaneous + operators plot string struct diff --git a/py-polars/docs/source/reference/series/list.rst b/py-polars/docs/source/reference/series/list.rst index a9a11001402b..ab857679c059 100644 --- a/py-polars/docs/source/reference/series/list.rst +++ b/py-polars/docs/source/reference/series/list.rst @@ -11,17 +11,18 @@ The following methods are available under the `Series.list` attribute. Series.list.all Series.list.any - Series.list.drop_nulls Series.list.arg_max Series.list.arg_min Series.list.concat Series.list.contains Series.list.count_matches Series.list.diff + Series.list.drop_nulls Series.list.eval Series.list.explode Series.list.first Series.list.gather + Series.list.gather_every Series.list.get Series.list.head Series.list.join @@ -31,6 +32,7 @@ The following methods are available under the `Series.list` attribute. Series.list.mean Series.list.median Series.list.min + Series.list.n_unique Series.list.reverse Series.list.sample Series.list.set_difference @@ -46,6 +48,4 @@ The following methods are available under the `Series.list` attribute. Series.list.to_array Series.list.to_struct Series.list.unique - Series.list.n_unique Series.list.var - Series.list.gather_every diff --git a/py-polars/docs/source/reference/series/miscellaneous.rst b/py-polars/docs/source/reference/series/miscellaneous.rst index 7928cf87ad4e..729071b69b95 100644 --- a/py-polars/docs/source/reference/series/miscellaneous.rst +++ b/py-polars/docs/source/reference/series/miscellaneous.rst @@ -7,8 +7,8 @@ Miscellaneous :toctree: api/ Series.equals + Series.get_chunks Series.map_elements Series.reinterpret Series.set_sorted Series.to_physical - Series.get_chunks diff --git a/py-polars/docs/source/reference/sql/functions/aggregate.rst b/py-polars/docs/source/reference/sql/functions/aggregate.rst index 0c574283d4b5..0244af235175 100644 --- a/py-polars/docs/source/reference/sql/functions/aggregate.rst +++ b/py-polars/docs/source/reference/sql/functions/aggregate.rst @@ -202,7 +202,7 @@ Returns the smallest (minimum) of all the elements in the grouping. STDDEV ------ -Returns the standard deviation of all the elements in the grouping. +Returns the sample standard deviation of all the elements in the grouping. .. admonition:: Aliases