Joris Van den Bossche created ARROW-15321:
---------------------------------------------
Summary: [Dev][Archery] numpydoc validation doesn't check all
class methods
Key: ARROW-15321
URL: https://issues.apache.org/jira/browse/ARROW-15321
Project: Apache Arrow
Issue Type: Bug
Components: Developer Tools
Reporter: Joris Van den Bossche
>From discussion at
>https://github.com/apache/arrow/pull/12076#discussion_r783810077
It seems that by default, it doesn't loop over all _methods_ of classes, but
only module-level objects?
For example, I notice that explicitly asking for {{pyarrow.Table.to_pandas}}
catches some issues:
{code}
$ archery numpydoc pyarrow.Table.to_pandas --allow-rule PR10
INFO:archery:Running Python docstring linters
PR10: Parameter "categories" requires a space before the colon separating the
parameter name and type
PR10: Parameter "use_threads" requires a space before the colon separating the
parameter name and type
{code}
But with the default (check all of pyarrow) with {{archery numpydoc
--allow-rule PR10}} it doesn't list those errors.
cc [~kszucs] [~amol-]
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
