Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dcreekp opened this issue Feb 3, 2019 · 1 comment
Labels

Comments

@dcreekp
Copy link
Contributor

dcreekp commented Feb 3, 2019

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.

@jschendel jschendel added the Docs label Feb 7, 2019
@dcreekp dcreekp changed the title DOC: make scripts/validate_docstrings.py be able to exclude a list of known docstrings to ignore DOC: make scripts/validate_docstrings.py GL01 GL02 be able to exclude a list of known docstrings to ignore Feb 25, 2019
@mroeschke
Copy link
Member

Closing as a duplicate of #25324

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants