Skip to content

Commit dcf2553

Browse files
committed
DOC: fix inaccuracy in validate docstring.
1 parent 676a8d4 commit dcf2553

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

numpydoc/validate.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -425,14 +425,17 @@ def _check_desc(desc, code_no_desc, code_no_upper, code_no_period, **kwargs):
425425
return errs
426426

427427

428-
def validate(func_name):
428+
def validate(obj_name):
429429
"""
430430
Validate the docstring.
431431
432432
Parameters
433433
----------
434-
func_name : function
435-
Function whose docstring will be evaluated (e.g. pandas.read_csv).
434+
obj_name : str
435+
The name of the object whose docstring will be evaluated, e.g.
436+
'pandas.read_csv'. The string must include the full, unabbreviated
437+
package/module names, i.e. 'pandas.read_csv', not 'pd.read_csv' or
438+
'read_csv'.
436439
437440
Returns
438441
-------

0 commit comments

Comments
 (0)