apache / apache/arrow

[Python][Doc] Enable remainder of discussed numpydoc checks

Open
#33,646 4 comments 0 reactions 1 assignee Claimed by @amoeba View on GitHub
Component: Documentation Component: Python Type: enhancement
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

### Describe the enhancement requested

Following up from https://github.com/apache/arrow/issues/30525, we should try to enable the remainder of the [numpydoc](https://numpydoc.readthedocs.io/) checks that highlighted as worth implementing in that discussion and in the [supporting Google Sheet](docs.google.com/spreadsheets/d/1NVzQe3MA4Mh-AqsWUmwIZu9r5gB-Lmugz7mge3stYvU).

The remainder includes the following checks:

- `GL08:` The object does not have a docstring
- `SS01`: No summary found (a short summary in a single line should be present at the beginning of the docstring)
- `PR06`: Parameter "{param_name}" type should use "{right_type}" instead of "{wrong_type}"
- `PR07`: Parameter "{param_name}" has no description
- `RT01`: No Returns section found

To give a sense of how much work this might be, I ran archery numpydoc with these checks and got the following number of failures for each (outdated now but should be close):

Code | Failures
-----|---------
GL08 | 203
SS01 | 17
PR06 | 83
PR07 | 206
RT01 | 295

### Component(s)

Documentation, Python

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.