Skip to content

Commit 785a7c0

Browse files
committed
Fix in prefix_pandas and mark.parameterize
1 parent 4cf7e1b commit 785a7c0

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
@@ -550,11 +550,12 @@ class BadSeeAlso(object):
550550

551551
def prefix_pandas(self):
552552
"""
553-
Return prefix with `pandas` from See Also sec
553+
Have `pandas` prefix in See Also section.
554554
555555
See Also
556556
--------
557-
pandas.Series.rename : Alter Series index labels or name
557+
pandas.Series.rename : Alter Series index labels or name.
558+
DataFrame.head : The first `n` rows of the caller object.
558559
"""
559560
pass
560561

@@ -670,9 +671,9 @@ def test_bad_generic_functions(self, func):
670671
marks=pytest.mark.xfail),
671672
pytest.param('BadReturns', 'no_punctuation', ('foo',),
672673
marks=pytest.mark.xfail),
673-
# SeeAlso tests
674+
# See Also tests
674675
('BadSeeAlso', 'prefix_pandas',
675-
('section does not need `pandas` prefix',)),
676+
('pandas.Series.rename in `See Also` section does not need `pandas` prefix',)),
676677
])
677678
def test_bad_examples(self, capsys, klass, func, msgs):
678679
result = validate_one(self._import_path(klass=klass, func=func)) # noqa:F821

0 commit comments

Comments
 (0)