-
-
Notifications
You must be signed in to change notification settings - Fork 18.7k
Description
pandas has a script for validating docstrings
Lines 560 to 568 in ced9833
MSG='Partially validate docstrings (EX02)' ; echo $MSG | |
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX02 --ignore_functions \ | |
pandas.DataFrame.plot.line \ | |
pandas.Series.plot.line \ | |
pandas.api.types.is_datetime64_any_dtype \ | |
pandas.api.types.is_datetime64_ns_dtype \ | |
pandas.api.types.is_datetime64tz_dtype \ | |
pandas.plotting.parallel_coordinates | |
RET=$(($RET + $?)) ; echo $MSG "DONE" |
which can be run with
./ci/code_checks.sh docstrings
Currently, many functions fail the EX02 check, and so are excluded from the check.
The task here is:
- pick 2-3 functions
- run
./ci/code_checks.sh docstrings
- fixup the docstrings according to whatever error is reported
- stage, commit, push, open pull request 🚀
Please don't comment take
as multiple people can work on this simultaneously. You also don't need to ask for permission to work on this, feel free to just start 😄 Though if you're working on some set of functions you can comment that
If you're new here, please check the contributing guide https://pandas.pydata.org/docs/dev/development/contributing.html
TIP: ./ci/code_checks.sh docstrings
may take a while to run - you may want to comment-out the docstrings
check which checks EX01
and the part which checks all the other codes (these are currently lines 86 - 577)