Skip to content
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.

Sign up for GitHub

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

Jump to bottom

DOC: Improve GL03 message re: blank lines at end of docstrings. #23649

Merged
merged 6 commits into from
Nov 20, 2018
Merged

DOC: Improve GL03 message re: blank lines at end of docstrings. #23649

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a73ab81
DOC: Improve GL03 message re: blank lines at end of docstrings.
douglatornell Nov 12, 2018
6a12b87
DOC: Add tests for extra linebreaks in docstrings.
douglatornell Nov 13, 2018
d91bed8
Merge branch 'master' into validate_docstrings-GL03-msg.
douglatornell Nov 18, 2018
e727568
DOC: Move GL03 extra linebreak tests into test_bad_examples().
douglatornell Nov 18, 2018
a7d2dbc
Revert "DOC: Move GL03 extra linebreak tests into test_bad_examples()."
douglatornell Nov 19, 2018
07ed212
DOC: Improve test function name & move extra linebreak tests.
douglatornell Nov 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion scripts/validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@
'in the docstring (do not close the quotes in the same line as '
'the text, or leave a blank line between the last text and the '
'quotes)',
'GL03': 'Use only one blank line to separate sections or paragraphs',
'GL03': 'Double line break found; please use only one blank line to '
'separate sections or paragraphs, and do not leave blank lines '
'at the end of docstrings',
'GL04': 'Private classes ({mentioned_private_classes}) should not be '
'mentioned in public docstrings',
'GL05': 'Tabs found at the start of line "{line_with_tabs}", please use '
Expand Down