diff options
| author | Ross Barnowski <rossbar@berkeley.edu> | 2020-08-12 16:14:41 -0700 |
|---|---|---|
| committer | Ross Barnowski <rossbar@berkeley.edu> | 2020-08-12 16:14:41 -0700 |
| commit | dcf25536c2a54cffb9d1e6663795c370eb93b350 (patch) | |
| tree | 41f8088bb36415c44f8d10d209ebc50a9db78b18 | |
| parent | 676a8d4c1627e92052c2f3a5e2bde558e9a59f96 (diff) | |
| download | numpydoc-dcf25536c2a54cffb9d1e6663795c370eb93b350.tar.gz | |
DOC: fix inaccuracy in validate docstring.
| -rw-r--r-- | numpydoc/validate.py | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/numpydoc/validate.py b/numpydoc/validate.py index 1fd80e1..76521e9 100644 --- a/numpydoc/validate.py +++ b/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 ------- |