Skip to content

DOC fix EX02 errors in docstrings #51236

Closed
@MarcoGorelli

Description

@MarcoGorelli

pandas has a script for validating docstrings

pandas/ci/code_checks.sh

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:

  1. pick 2-3 functions
  2. run ./ci/code_checks.sh docstrings
  3. fixup the docstrings according to whatever error is reported
  4. 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)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions