Closed
Description
follow up on issues #56804 and #58063
pandas has a script for validating docstrings:
Lines 206 to 244 in 0cdc6a4
Currently, some methods fail docstring validation check.
The task here is:
- take 2-4 methods
- run:
scripts/validate_docstrings.py <method-name>
- fix the docstrings according to whatever error is reported
- remove those methods from
code_checks.sh
script - commit, push, open pull request
Example:
scripts/validate_docstrings.py pandas.Timestamp.tz_localize
pandas.Timestamp.tz_localize fails with the SA01 error
################################################################################
################################## Validation ##################################
################################################################################
1 Errors found for `pandas.Timestamp.tz_localize`:
SA01 See Also section not found
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