[jira] [Comment Edited] (ARROW-15321) [Dev][Archery] numpydoc validation doesn't check all class methods

["Krisztian Szucs (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-15321?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17475278#comment-17475278 ] 

Krisztian Szucs edited comment on ARROW-15321 at 1/13/22, 11:23 AM:
--------------------------------------------------------------------

Correct, the cython defined symbols are not supported by numpydoc so we need to have workarounds for them. 

We may try to disable the module checks for classes to see how much noise it introduces.


was (Author: kszucs):
Correct, the cython defined symbols are not supported by numpydoc so we need to have workarounds for them. 

We may try to disable the module checks for classes to see how much noise does it introduce. 

> [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, Python
>            Reporter: Joris Van den Bossche
>            Assignee: Alessandro Molina
>            Priority: Major
>             Fix For: 8.0.0
>
>
> 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)