-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
Fix docstrings #27621
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
Fix docstrings #27621
Conversation
odd that the doc string checks don’t catch this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @albertvillanova for this, nice fixes.
It feels like sphinx should be raising warnings for those, but I guess both sphinx and our script consider those as just part of a paragraph.
Can you leave the CI green (I guess the failure is unrelated to this PR, and you can simply merge master or add an empty commit).
And also, if you can open an issue to validate those automatically, and may be work on adding validation for this in the scripts/validate_docstrings.py
script, that would be great.
2 dots followed by text (and no 2 colons) are valid reST comments, thus ignored by the parser: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#comments |
Thanks @albertvillanova, that's good to know. I think then we should make sure in If you don't mind creating an issue for that, and referencing this PR in it, so we can see where it came from, that would be great. And thanks for the PR! |
black pandas
git diff upstream/master -u -- "*.py" | flake8 --diff
This fixes some docstring formatting issues: e.g. some deprecated directives do not appear in current docs because the two colons are missing
.. deprecated 0.25.0
.