Doc numpydoc validation for docstrings in BernoulliNB #15513
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
|
Looks good to me pending CI. Please check for overlap with #15508 |
rth
reviewed
Nov 3, 2019
| [3] | ||
| See Also | ||
| ---------- | ||
| MultinomialNB: The multinomial Naive Bayes classifier is \ |
There was a problem hiding this comment.
I think the backslash at the end is not needed.
There was a problem hiding this comment.
Thanks, @rth! I tried having that bit of text on one line, but the pytest failed. Splitting into two lines made the pytest succeed, but when I submitted the PR without the backslash at the end, the lint check failed. Adding it at the recommendation of @TomDLT made it pass the lint test.
Is there another approach I should try instead?
There was a problem hiding this comment.
Fair enough, the docstring renders fine in any case. Thanks!
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.
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Fixed
fit_priordata to bebool, and added "See Also" section.Any other comments?