[DOC] Make build_analyzer docstring more precise#13786
Merged
rth merged 2 commits intoscikit-learn:masterfrom Jul 3, 2019
Merged
[DOC] Make build_analyzer docstring more precise#13786rth merged 2 commits intoscikit-learn:masterfrom
rth merged 2 commits intoscikit-learn:masterfrom
Conversation
jnothman
reviewed
May 5, 2019
sklearn/feature_extraction/text.py
Outdated
|
|
||
| def build_analyzer(self): | ||
| """Return a callable that handles preprocessing and tokenization""" | ||
| """Return a callable that handles preprocessing, tokenization and n-grams generation""" |
Member
There was a problem hiding this comment.
Please keep lines under 80 characters
Member
There was a problem hiding this comment.
Also from https://www.python.org/dev/peps/pep-0257/
Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description. The summary line may be used by automatic indexing tools; it is important that it fits on one line and is separated from the rest of the docstring by a blank line.
So we can't add a newline break here ether. The only solution could be to remove some words from the summary line.
Member
|
So let's make this change to the description not the summary.
|
Member
|
Addressed comments. Merging. Thanks! |
koenvandevelde
pushed a commit
to koenvandevelde/scikit-learn
that referenced
this pull request
Jul 12, 2019
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Minor doc fix.