DOC: fix inaccuracy in validate docstring. (#294)

Author: jnothman

numpydoc/validate.py

@@ -425,14 +425,17 @@ def _check_desc(desc, code_no_desc, code_no_upper, code_no_period, **kwargs):
     return errs
 
 
-def validate(func_name):
+def validate(obj_name):
     """
     Validate the docstring.
 
     Parameters
     ----------
-    func_name : function
-        Function whose docstring will be evaluated (e.g. pandas.read_csv).
+    obj_name : str
+        The name of the object whose docstring will be evaluated, e.g.
+        'pandas.read_csv'. The string must include the full, unabbreviated
+        package/module names, i.e. 'pandas.read_csv', not 'pd.read_csv' or
+        'read_csv'.
 
     Returns
     -------
@@ -465,7 +468,7 @@ def validate(func_name):
     they are validated, are not documented more than in the source code of this
     function.
     """
-    doc = Docstring(func_name)
+    doc = Docstring(obj_name)
 
     errs = []
     if not doc.raw_doc: