Skip to content

MINOR: [Docs][Python] Update the Grouped Aggregations API section now functions are hidden #11803

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.

Sign up for GitHub

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

Closed
jorisvandenbossche wants to merge 1 commit into from
Closed

MINOR: [Docs][Python] Update the Grouped Aggregations API section now functions are hidden #11803

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 19 additions & 18 deletions docs/source/python/api/compute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Copy link
Member

@amol- amol- Dec 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

sshot

Copy link
Member Author

@jorisvandenbossche jorisvandenbossche Dec 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(IMO then we could also simply not hide the functions, and keep them available for introspection like that)

Copy link
Member

@amol- amol- Dec 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I think we can now remove them from the API Reference (in the end if you can't invoke them it's not true that they are an available api) and I ended up adding the list of them in the compute documentation improvement I was working on: https://github.com/apache/arrow/pull/11830/files

Copy link
Member Author

@jorisvandenbossche jorisvandenbossche Dec 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you can remove this list in #11830 (or replace it with your custom directive), instead of merging this PR?

Copy link
Member

@amol- amol- Dec 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me, feel free to close this one.


Arithmetic Functions
--------------------
Expand Down