Update error message and test validator

Author: thoo

scripts/tests/test_validate_docstrings.py

@@ -333,15 +333,6 @@ def method(self, foo=None, bar=None):
         """
         pass
 
-
-class BadSeeAlso(object):
-
-    def prefix_pandas(self):
-        """
-        Return  prefix with `pandas` from See Also sec
-        """
-        pass
-
 class BadSummaries(object):
 
     def wrong_line(self):
@@ -553,6 +544,13 @@ def no_punctuation(self):
         """
         return "Hello world!"
 
+class BadSeeAlso(object):
+
+    def prefix_pandas(self):
+        """
+        Return  prefix with `pandas` from See Also sec
+        """
+        pass
 
 class TestValidator(object):
 
@@ -616,9 +614,6 @@ def test_bad_generic_functions(self, func):
         assert errors
 
     @pytest.mark.parametrize("klass,func,msgs", [
-        #SeeAlso tests
-        ('BadSeeAlso', 'prefix_pandas',
-         ('Should not start with pandas',)),
         # Summary tests
         ('BadSummaries', 'wrong_line',
          ('should start in the line immediately after the opening quotes',)),
@@ -667,7 +662,10 @@ def test_bad_generic_functions(self, func):
         pytest.param('BadReturns', 'no_description', ('foo',),
                      marks=pytest.mark.xfail),
         pytest.param('BadReturns', 'no_punctuation', ('foo',),
-                     marks=pytest.mark.xfail)
+                     marks=pytest.mark.xfail),
+        # SeeAlso tests
+        ('BadSeeAlso', 'prefix_pandas',
+         ('Should not start with pandas',)),
     ])
     def test_bad_examples(self, capsys, klass, func, msgs):
         result = validate_one(self._import_path(klass=klass, func=func))  # noqa:F821

scripts/validate_docstrings.py

@@ -508,8 +508,9 @@ def validate_one(func_name):
             if not rel_desc:
                 errs.append('Missing description for '
                             'See Also "{}" reference'.format(rel_name))
-            if rel_name[:7].lower() == 'pandas.':
-                errs.append('{} should not have prefix `pandas`'.format(rel_name))
+            if rel_name.startswith('pandas.'):
+                errs.append('{} in the `See Also` section does not need the `pandas` prefix, '
+                            'use {} instead.'.format(rel_name,rel_name.replace('pandas.','')))
     for line in doc.raw_doc.splitlines():
         if re.match("^ *\t", line):
             errs.append('Tabs found at the start of line "{}", '