Skip to content

DOC: make scripts/validate_docstrings.py GL01 GL02 be able to exclude a list of known docstrings to ignore  #25120

Closed
@dcreekp

Description

@dcreekp

Problem description

We want this script to return zero errors:

$ ./scripts/validate_docstrings.py --prefix=pandas.Time --errors=GL01,GL02

to add GL01 and GL02 to the continuous integration checks.
However the remaining errors are caused by docstrings that are inherited from dependencies. Specifically, cpython's datetime module which we do not want to touch.

from trying to fix this issue

Expected Output

For the above script to return zero errors.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions