-
Notifications
You must be signed in to change notification settings - Fork 4k
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.
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
MINOR: [Docs][Python] Update the Grouped Aggregations API section now functions are hidden #11803
Conversation
… functions are hidden
|
Thanks for catching this, I actually wanted to rework the compute documentation in https://issues.apache.org/jira/browse/ARROW-13832 but didn't yet have a chance to get there. I wonder if this is something the CI should be able to catch. |
We can make the doc build fail on warnings (we eg do that in pandas' CI) to catch things like this (sphinx has an option for that). The main problem is that:
|
|
Although #11567 is already addressing some of those issues I think |
| * ``hash_stddev`` | ||
| * ``hash_sum`` | ||
| * ``hash_tdigest`` | ||
| * ``hash_variance`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.

No description provided.