[
https://issues.apache.org/jira/browse/ARROW-17542?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17647646#comment-17647646
]
Apache Arrow JIRA Bot commented on ARROW-17542:
-----------------------------------------------
This issue was last updated over 90 days ago, which may be an indication it is
no longer being actively worked. To better reflect the current state, the issue
is being unassigned per [project
policy|https://arrow.apache.org/docs/dev/developers/bug_reports.html#issue-assignment].
Please feel free to re-take assignment of the issue if it is being actively
worked, or if you plan to start that work soon.
> [Python][Dev] Document the process to run numpydoc checks
> ---------------------------------------------------------
>
> Key: ARROW-17542
> URL: https://issues.apache.org/jira/browse/ARROW-17542
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Archery, Developer Tools, Python
> Reporter: Bryce Mecum
> Assignee: Bryce Mecum
> Priority: Major
>
> In [ARROW-15006|https://issues.apache.org/jira/browse/ARROW-15006] we are
> adding additional validation checks which are run during CI but the [Python
> development
> documentation|https://arrow.apache.org/docs/developers/python.html] doesn't
> contain any instructions for running those checks locally. Adding
> instructions would likely save everyone time.
> However, we actually have two separate ways to run the numpydoc checks
> locally:
> - archery lint --numpydoc (runs all checks)
> - archery numpydoc (runs all checks except except four we've disabled by
> default)
> And these two methods differ from how CI runs numpydoc which only runs the
> three checks (PR01, PR03, and PR10) we know currently pass.
> My thoughts so far are:
> - Having two similar but different ways of running numpydoc might be confusing
> - Ideally, new work should pass all numpydoc checks, not just those we run in
> CI. Otherwise we're just making future work for ourselves.
> - Giving developers an easy way to run just the checks we have enabled in CI
> would be good
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
