You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When running the docstring validation script, errors are mistakenly reported if parameters have a deprecated, versionadded or versionchanged directive.
For example, when running ./scripts/validate_docstrings.py pandas.DataFrame.mode, the next error is returned by the script:
################################################################################
################################## Validation ##################################
################################################################################
Errors found:
Errors in parameters section
Parameter "dropna" description should finish with "."
But the dropna parameter description does finish with a period:
Now adding deprecated and versionchanged directives as well.
datapythonista
changed the title
Consider versionadded when validating docstrings parameters
Consider directives when validating docstrings parameters
Aug 20, 2018
When running the docstring validation script, errors are mistakenly reported if parameters have a
deprecated
,versionadded
orversionchanged
directive.For example, when running
./scripts/validate_docstrings.py pandas.DataFrame.mode
, the next error is returned by the script:But the
dropna
parameter description does finish with a period:The problem is that the
.. versionadded::
directive is not considered.The script should ignore the directive when validating, and shouldn't report the error in this case.
The text was updated successfully, but these errors were encountered: