pandas: DOC: fix RT03 errors in docstrings

Pandas has a script for validating docstrings:

https://github.com/pandas-dev/pandas/blob/44c50b20e8d08613144b3353d9cd0844a53bd077/ci/code_checks.sh#L144-L414

Currently, some methods fail the RT03 check.

The task here is:

  1. take 2-4 methods
  2. run: scripts/validate_docstrings.py --format=actions --errors=RT03 method-name
  3. check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported
  4. remove those methods from code_checks.sh
  5. commit, push, open pull request

Please don’t comment take as multiple people can work on this issue. You also don’t need to ask for permission to work on this, just comment on which methods are you going to work.

If you’re new contributor, please check the contributing guide

About this issue

  • Original URL
  • State: closed
  • Created 5 months ago
  • Comments: 18 (18 by maintainers)

Most upvoted comments

https://github.com/pandas-dev/pandas/blob/dc19148bf7197a928a129b1d1679b1445a7ea7c7/ci/code_checks.sh#L615-L864

Current status: still 200+ method docstrings need to be fixed, maybe add the “good first issue” tag to get more people involved 😉