TST Enable numpydoc validation default #20304
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Should we maybe do this as part of the lint job if it doesn't take too long? |
We can try to do this as a part of lint when numpydoc validation passes everywhere. |
|
OK, that works. |
sakibguy
added a commit
to sakibguy/scikit-learn
that referenced
this pull request
Jun 22, 2021
TST Enable numpydoc validation default (scikit-learn#20304)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR changes the logic of this to have an "ignore list". This way we can ensure that our docstrings are always validated once we fix the ones in
DOCSTRING_IGNORE_LIST.I see this as a sprint item where contributors can:
DOCSTRING_IGNORE_LIST.pytest maint_tools/test_docstrings.py -k SGDClassifierCC @rth