Skip to content

DOC: Add docstring validations for "See Also" section #23143

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

Merged
merged 6 commits into from
Oct 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions scripts/tests/test_validate_docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,33 @@ def method(self, foo=None, bar=None):
pass


class BadSeeAlso(object):

def desc_no_period(self):
"""
Return the first 5 elements of the Series.

See Also
--------
Series.tail : Return the last 5 elements of the Series.
Series.iloc : Return a slice of the elements in the Series,
which can also be used to return the first or last n
"""
pass

def desc_first_letter_lowercase(self):
"""
Return the first 5 elements of the Series.

See Also
--------
Series.tail : return the last 5 elements of the Series.
Series.iloc : Return a slice of the elements in the Series,
which can also be used to return the first or last n.
"""
pass


class BadSummaries(object):

def wrong_line(self):
Expand Down Expand Up @@ -564,6 +591,11 @@ def test_bad_generic_functions(self, func):
assert errors

@pytest.mark.parametrize("klass,func,msgs", [
# See Also tests
('BadSeeAlso', 'desc_no_period',
('Missing period at end of description for See Also "Series.iloc"',)),
('BadSeeAlso', 'desc_first_letter_lowercase',
('should be capitalized for See Also "Series.tail"',)),
# Summary tests
('BadSummaries', 'wrong_line',
('should start in the line immediately after the opening quotes',)),
Expand Down
9 changes: 8 additions & 1 deletion scripts/validate_docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,14 @@ def validate_one(func_name):
wrns.append('See Also section not found')
else:
for rel_name, rel_desc in doc.see_also.items():
if not rel_desc:
if rel_desc:
if not rel_desc.endswith('.'):
errs.append('Missing period at end of description for '
'See Also "{}" reference'.format(rel_name))
if not rel_desc[0].isupper():
errs.append('Description should be capitalized for '
'See Also "{}" reference'.format(rel_name))
else:
errs.append('Missing description for '
'See Also "{}" reference'.format(rel_name))

Expand Down