Skip to content

DOC: Validate description of See Also section in docstrings #23135

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 Oct 13, 2018 · 0 comments · Fixed by #23143
Closed

DOC: Validate description of See Also section in docstrings #23135

datapythonista opened this issue Oct 13, 2018 · 0 comments · Fixed by #23143
Labels
CI Continuous Integration Docs good first issue

Comments

@datapythonista
Copy link
Member

scripts/validate_docstrings.py validates that the content of a docstring follows our standards. There are still some of those standards that the script does not validate, and this gives the users the wrong impression that the docstring is all right, when it's not really the case. All the missing validations are listed in #20298.

One of the standards is that the descriptions in the See Also section should start by a capital letter and finish with a period.

For this issue is required:

  • Change scripts/validate_docstings.py to give an error if the descriptions do not follow to mentioned standard.
  • Add tests in scripts/tests/test_validate_docstrings.py
  • Run the script for all docstrings (i.e. ./scripts/validate_docstings.py) and check in the resulting report how many of the docstrings in pandas have these imports. Add as a comment in this issue the list.
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
1 participant