Skip to content

CI: Add --ignore-deprecated to validate_docstrings.py #23631

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
datapythonista opened this issue Nov 11, 2018 · 3 comments · Fixed by #23650
Closed

CI: Add --ignore-deprecated to validate_docstrings.py #23631

datapythonista opened this issue Nov 11, 2018 · 3 comments · Fixed by #23650
Labels
CI Continuous Integration Docs good first issue
Milestone

Comments

@datapythonista
Copy link
Member

The script scripts/validate_docstrings.py returns the list of errors in the docstrings. We are using it to get the list of things to fix, and to check in the CI that no more mistakes are added, after the errors are fixed. See for example #23630.

As we don't really want to spend time fixing the docstrings that will be removed soon, it would be useful to add an argument to the script --ignore-deprecated that skips the functions/methods that are marked as deprecated (see Docstring.deprecated).

Things to note:

  • When deprecated docstrings are skipped, they should not be displayed in the output of the script, and also not counted in the exit status of the script (so, the script should finish with exit status 0 if --ignore-deprecated is set and only deprecated functions are wrong).
  • We should add at least one test to make sure the new argument works as expected.
@charlesdong1991
Copy link
Member

charlesdong1991 commented Nov 12, 2018

i will give a try...

@datapythonista
Copy link
Member Author

Sure @charlesdong1991, please do.

@charlesdong1991
Copy link
Member

#23650

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants