jorisvandenbossche commented on a change in pull request #12076:
URL: https://github.com/apache/arrow/pull/12076#discussion_r783804411
##########
File path: python/pyarrow/_compute.pyx
##########
@@ -1027,6 +1266,15 @@ cdef class _ScalarAggregateOptions(FunctionOptions):
class ScalarAggregateOptions(_ScalarAggregateOptions):
+ __doc__ = f"""
+ Options for scalar aggregations.
+
+ Parameters
+ ----------
+ {_skip_nulls_doc()}
Review comment:
> I guess one possible solution would be to have something inspecting
the class and confirming the arguments in `__init__` match with those
documented.
We have numpydoc validation check that already should do something like
that? (I don't remember if it is ran by default, or is ran for the compute
module)
But, that would also not really solve your concern that the "meaning" of the
keyword would change for one of the functions (checking that the signature
keywords match with the documented keywords doesn't guarantee anything about
whether the description content is correct or not)
##########
File path: python/pyarrow/_compute.pyx
##########
@@ -1027,6 +1266,15 @@ cdef class _ScalarAggregateOptions(FunctionOptions):
class ScalarAggregateOptions(_ScalarAggregateOptions):
+ __doc__ = f"""
+ Options for scalar aggregations.
+
+ Parameters
+ ----------
+ {_skip_nulls_doc()}
Review comment:
> I guess one possible solution would be to have something inspecting
the class and confirming the arguments in `__init__` match with those
documented.
We have numpydoc validation check that already should do something like
that? (I don't remember if it is ran by default, or is ran for the compute
module)
But, that would also not really solve your concern that the "meaning" of the
keyword would change for one of the functions? (checking that the signature
keywords match with the documented keywords doesn't guarantee anything about
whether the description content is correct or not)
--
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]
