[ARROW-15321] [Dev][Archery] numpydoc validation doesn't check all class methods

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 8.0.0
• Component/s: Developer Tools, Python
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/30809
• Assignee: Antoine Pitrou
• Reporter: Joris Van den Bossche
• Created: 13/Jan/22 10:46
• Updated: 11/Jan/23 11:36
• Resolved: 28/Mar/22 16:55

Description

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:

$ 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

But with the default (check all of pyarrow) with archery numpydoc --allow-rule PR10 it doesn't list those errors.

cc kszucs amol-

Issue Links

• links to: GitHub Pull Request #12698