[MRG+1] DOC insert spaces before colons in parameter lists #7920
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
Complies with numpydoc to improve rendering and automatic quality assurance such as scikit-learn#7793. Affects listings of Parameters Attributes, Returns. Performed with the help of: grep -nE '^( )+[a-zA-Z][a-zA-Z0-9_]*: ' sklearn -R | grep -v -e externals -e tests | grep -v -e default: -e else: -e Warning: -e Note: -e TRAIN: -e Default: -e True: -e False: -e DOI: -e In: | gsed 's|\([^:]*\):\([0-9]*\):\([^:]*\):\(.*\)|--- a/\1\n+++ b/\1\n@@ -\2,1 +\2,1 @@\n-\3:\4\n+\3 :\4|' | git apply --unidiff-zero -
raghavrv
approved these changes
Nov 23, 2016
| The dictionary to pretty print | ||
|
|
||
| offset: int | ||
| offset : int | ||
| The offset in characters to add at the begin of each line. | ||
|
|
||
| printer: |
There was a problem hiding this comment.
This somehow slipped through your pretty nifty grep / sed commands... ;)
There was a problem hiding this comment.
well numpydoc doesn't actually support a colon without something following...
There was a problem hiding this comment.
Fixing this, and looked for others like it.
|
Will it be enforced in #7793 ? |
|
It's not really easy to do all in one go. Much easier to fix this kind of lint error then check for discrepancy. I'm building a linter/fixer for both kinds of issue. |
|
Ok, merging |
sergeyf
pushed a commit
to sergeyf/scikit-learn
that referenced
this pull request
Feb 28, 2017
…arn#7920) * DOC insert spaces before colons in parameter lists Complies with numpydoc to improve rendering and automatic quality assurance such as scikit-learn#7793. Affects listings of Parameters Attributes, Returns. Performed with the help of: grep -nE '^( )+[a-zA-Z][a-zA-Z0-9_]*: ' sklearn -R | grep -v -e externals -e tests | grep -v -e default: -e else: -e Warning: -e Note: -e TRAIN: -e Default: -e True: -e False: -e DOI: -e In: | gsed 's|\([^:]*\):\([0-9]*\):\([^:]*\):\(.*\)|--- a/\1\n+++ b/\1\n@@ -\2,1 +\2,1 @@\n-\3:\4\n+\3 :\4|' | git apply --unidiff-zero - * DOC fix numpydoc format for param
Sundrique
pushed a commit
to Sundrique/scikit-learn
that referenced
this pull request
Jun 14, 2017
…arn#7920) * DOC insert spaces before colons in parameter lists Complies with numpydoc to improve rendering and automatic quality assurance such as scikit-learn#7793. Affects listings of Parameters Attributes, Returns. Performed with the help of: grep -nE '^( )+[a-zA-Z][a-zA-Z0-9_]*: ' sklearn -R | grep -v -e externals -e tests | grep -v -e default: -e else: -e Warning: -e Note: -e TRAIN: -e Default: -e True: -e False: -e DOI: -e In: | gsed 's|\([^:]*\):\([0-9]*\):\([^:]*\):\(.*\)|--- a/\1\n+++ b/\1\n@@ -\2,1 +\2,1 @@\n-\3:\4\n+\3 :\4|' | git apply --unidiff-zero - * DOC fix numpydoc format for param
NelleV
pushed a commit
to NelleV/scikit-learn
that referenced
this pull request
Aug 11, 2017
…arn#7920) * DOC insert spaces before colons in parameter lists Complies with numpydoc to improve rendering and automatic quality assurance such as scikit-learn#7793. Affects listings of Parameters Attributes, Returns. Performed with the help of: grep -nE '^( )+[a-zA-Z][a-zA-Z0-9_]*: ' sklearn -R | grep -v -e externals -e tests | grep -v -e default: -e else: -e Warning: -e Note: -e TRAIN: -e Default: -e True: -e False: -e DOI: -e In: | gsed 's|\([^:]*\):\([0-9]*\):\([^:]*\):\(.*\)|--- a/\1\n+++ b/\1\n@@ -\2,1 +\2,1 @@\n-\3:\4\n+\3 :\4|' | git apply --unidiff-zero - * DOC fix numpydoc format for param
paulha
pushed a commit
to paulha/scikit-learn
that referenced
this pull request
Aug 19, 2017
…arn#7920) * DOC insert spaces before colons in parameter lists Complies with numpydoc to improve rendering and automatic quality assurance such as scikit-learn#7793. Affects listings of Parameters Attributes, Returns. Performed with the help of: grep -nE '^( )+[a-zA-Z][a-zA-Z0-9_]*: ' sklearn -R | grep -v -e externals -e tests | grep -v -e default: -e else: -e Warning: -e Note: -e TRAIN: -e Default: -e True: -e False: -e DOI: -e In: | gsed 's|\([^:]*\):\([0-9]*\):\([^:]*\):\(.*\)|--- a/\1\n+++ b/\1\n@@ -\2,1 +\2,1 @@\n-\3:\4\n+\3 :\4|' | git apply --unidiff-zero - * DOC fix numpydoc format for param
maskani-moh
pushed a commit
to maskani-moh/scikit-learn
that referenced
this pull request
Nov 15, 2017
…arn#7920) * DOC insert spaces before colons in parameter lists Complies with numpydoc to improve rendering and automatic quality assurance such as scikit-learn#7793. Affects listings of Parameters Attributes, Returns. Performed with the help of: grep -nE '^( )+[a-zA-Z][a-zA-Z0-9_]*: ' sklearn -R | grep -v -e externals -e tests | grep -v -e default: -e else: -e Warning: -e Note: -e TRAIN: -e Default: -e True: -e False: -e DOI: -e In: | gsed 's|\([^:]*\):\([0-9]*\):\([^:]*\):\(.*\)|--- a/\1\n+++ b/\1\n@@ -\2,1 +\2,1 @@\n-\3:\4\n+\3 :\4|' | git apply --unidiff-zero - * DOC fix numpydoc format for param
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.
Complies with numpydoc to improve rendering, as well as automatic quality assurance as in #7793.
Affects listings of Parameters Attributes, Returns.
Performed with the help of: