Skip to content

Commit aa71fbb

Browse files
committed
Fix in prefix_pandas and mark.parameterize
1 parent 6e7ab2a commit aa71fbb

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

scripts/tests/test_validate_docstrings.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -506,11 +506,12 @@ class BadSeeAlso(object):
506506

507507
def prefix_pandas(self):
508508
"""
509-
Return prefix with `pandas` from See Also sec
509+
Have `pandas` prefix in See Also section.
510510
511511
See Also
512512
--------
513-
pandas.Series.rename : Alter Series index labels or name
513+
pandas.Series.rename : Alter Series index labels or name.
514+
DataFrame.head : The first `n` rows of the caller object.
514515
"""
515516
pass
516517

@@ -614,9 +615,9 @@ def test_bad_generic_functions(self, func):
614615
marks=pytest.mark.xfail),
615616
pytest.param('BadReturns', 'no_punctuation', ('foo',),
616617
marks=pytest.mark.xfail),
617-
# SeeAlso tests
618+
# See Also tests
618619
('BadSeeAlso', 'prefix_pandas',
619-
('section does not need `pandas` prefix',)),
620+
('pandas.Series.rename in `See Also` section does not need `pandas` prefix',)),
620621
])
621622
def test_bad_examples(self, capsys, klass, func, msgs):
622623
result = validate_one(self._import_path(klass=klass, func=func)) # noqa:F821

0 commit comments

Comments
 (0)