From d0cb43de71ea452c9bcb0381961c6e567f013a1e Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Tue, 30 Nov 2021 11:17:25 +0100 Subject: [PATCH] MINOR: [Docs][Python] Update the Grouped Aggregations API section now functions are hidden --- docs/source/python/api/compute.rst | 37 +++++++++++++++--------------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/source/python/api/compute.rst b/docs/source/python/api/compute.rst index 00897a24983..6adab314a87 100644 --- a/docs/source/python/api/compute.rst +++ b/docs/source/python/api/compute.rst @@ -48,24 +48,25 @@ Aggregations Grouped Aggregations -------------------- -.. autosummary:: - :toctree: ../generated/ - - hash_all - hash_any - hash_approximate_median - hash_count - hash_count_distinct - hash_distinct - hash_max - hash_mean - hash_min - hash_min_max - hash_product - hash_stddev - hash_sum - hash_tdigest - hash_variance +The grouped aggregation functions are not directly invokable, but are used +as part of a SQL-style "group by" operation using the +:meth:`~pyarrow.Table.group_by` method. A list of the available aggregations: + +* ``hash_all`` +* ``hash_any`` +* ``hash_approximate_median`` +* ``hash_count`` +* ``hash_count_distinct`` +* ``hash_distinct`` +* ``hash_max`` +* ``hash_mean`` +* ``hash_min`` +* ``hash_min_max`` +* ``hash_product`` +* ``hash_stddev`` +* ``hash_sum`` +* ``hash_tdigest`` +* ``hash_variance`` Arithmetic Functions --------------------