amol- commented on a change in pull request #11803:
URL: https://github.com/apache/arrow/pull/11803#discussion_r760110312
##########
File path: 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``
Review comment:
I think we will have to also add the docstring content somehow.
Otherwise we will be losing the column where we explain what the function does
in the output.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
