You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by GitBox <gi...@apache.org> on 2023/01/13 01:31:26 UTC

[GitHub] [arrow] amoeba opened a new issue, #33646: [Python][Doc] Enable remainder of discussed numpydoc checks

amoeba opened a new issue, #33646:
URL: https://github.com/apache/arrow/issues/33646

   ### 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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@arrow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow] amoeba commented on issue #33646: [Python][Doc] Enable remainder of discussed numpydoc checks

Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on issue #33646:
URL: https://github.com/apache/arrow/issues/33646#issuecomment-1402847533

   I got a [patch accepted](https://github.com/numpy/numpydoc/issues/446) so PR06 is unblocked now.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow] amoeba commented on issue #33646: [Python][Doc] Enable remainder of discussed numpydoc checks

Posted by GitBox <gi...@apache.org>.
amoeba commented on issue #33646:
URL: https://github.com/apache/arrow/issues/33646#issuecomment-1381195995

   assign


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow] amoeba commented on issue #33646: [Python][Doc] Enable remainder of discussed numpydoc checks

Posted by GitBox <gi...@apache.org>.
amoeba commented on issue #33646:
URL: https://github.com/apache/arrow/issues/33646#issuecomment-1381196384

   I've started working on PR06 and ran into one blocker with how numpydoc works. I filed an issue at https://github.com/numpy/numpydoc/issues/446.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org