Skip to content

#23648 - Validate docstring now checks for existence of docstring first. #23668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Conversation

iway1
Copy link

@iway1 iway1 commented Nov 13, 2018

TST - validate_one() will check if docstring exists before performing other checks. If it does not exist, then a single error will be returned reading 'Docstring does not exist'
PERF - validate_one will skip other validation checks if docstring doesn't exist, which will save time in cases of high volumes of function checks without docstrings.

screen shot 2018-11-13 at 10 58 12 am

TST - validate_one() will check if docstring exists before performing other checks. If it does not exist, then a single error will be returned reading 'Docstring does not exist'
PERF - validate_one will skip other validation checks if docstring doesn't exist, which will save time in cases of high volumes of function checks without docstrings.
@pep8speaks
Copy link

pep8speaks commented Nov 13, 2018

Hello @iway1! Thanks for updating the PR.

Comment last updated on November 13, 2018 at 21:14 Hours UTC

@gfyoung gfyoung added the Docs label Nov 13, 2018
@datapythonista
Copy link
Member

Closing this as duplicate of #23673 for now, see discussion in: #23673 (comment)

@iway1 next time check in the GitHub comments if someone else is working on an issue, to avoid repetitive work. If you and @avolkov prefer to continue the work in this PR, please reopen here, and close the other PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Add validation error when a docstring is missing
4 participants