Skip to content

Commit

Permalink
DOC: Improve GL03 message re: blank lines at end of docstrings. (pand…
Browse files Browse the repository at this point in the history
  • Loading branch information
douglatornell authored and Pingviinituutti committed Feb 28, 2019
1 parent e2e9334 commit 328f6a6
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
41 changes: 39 additions & 2 deletions scripts/tests/test_validate_docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,34 @@ def astype3(self, dtype):
"""
pass

def two_linebreaks_between_sections(self, foo):
"""
Test linebreaks message GL03.
Note 2 blank lines before parameters section.
Parameters
----------
foo : str
Description of foo parameter.
"""
pass

def linebreak_at_end_of_docstring(self, foo):
"""
Test linebreaks message GL03.
Note extra blank line at end of docstring.
Parameters
----------
foo : str
Description of foo parameter.
"""
pass

def plot(self, kind, **kwargs):
"""
Generate a plot.
Expand Down Expand Up @@ -723,7 +751,8 @@ def test_bad_class(self):
@capture_stderr
@pytest.mark.parametrize("func", [
'func', 'astype', 'astype1', 'astype2', 'astype3', 'plot', 'method',
'private_classes'])
'private_classes',
])
def test_bad_generic_functions(self, func):
errors = validate_one(self._import_path( # noqa:F821
klass='BadGenericDocStrings', func=func))['errors']
Expand Down Expand Up @@ -811,8 +840,16 @@ def test_bad_generic_functions(self, func):
'E226 missing whitespace around arithmetic operator',)),
('BadExamples', 'missing_whitespace_after_comma',
("flake8 error: E231 missing whitespace after ',' (3 times)",)),
('BadGenericDocStrings', 'two_linebreaks_between_sections',
('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',)),
('BadGenericDocStrings', 'linebreak_at_end_of_docstring',
('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',)),
])
def test_bad_examples(self, capsys, klass, func, msgs):
def test_bad_docstrings(self, capsys, klass, func, msgs):
result = validate_one(self._import_path(klass=klass, func=func))
for msg in msgs:
assert msg in ' '.join(err[1] for err in result['errors'])
Expand Down
4 changes: 3 additions & 1 deletion scripts/validate_docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,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

0 comments on commit 328f6a6

Please sign in to comment.