[MRG] DOC Homogeneous deprecation in docstring #8907
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
|
http://scikit-learn.org/circle?10335/_changed.html @jnothman Does it seem some reasonable directives? |
jnothman
reviewed
May 20, 2017
|
@lesteve Could you have a look at it. |
sklearn/ensemble/forest.py
Outdated
| if its impurity is above the threshold, otherwise it is a leaf. | ||
|
|
||
| .. deprecated:: 0.19 | ||
| ``min_impurity_split`` has been deprecated in favor of |
There was a problem hiding this comment.
you need some indentation here (like you do for the others)
lesteve
reviewed
May 22, 2017
doc/whats_new.rst
Outdated
| @@ -168,7 +168,7 @@ Enhancements | |||
| - Add ``sample_weight`` parameter to :func:`metrics.cohen_kappa_score` by | |||
| Victor Poughon. | |||
|
|
|||
| - In :class:`gaussian_process.GaussianProcessRegressor`, method ``predict`` | |||
| - In :class:`gaussian_process.GaussianProcessRegressor`, method ``predict`` | |||
There was a problem hiding this comment.
Please try to avoid unrelated changes like the ones in this file.
lesteve
reviewed
May 22, 2017
doc/developers/contributing.rst
Outdated
| @@ -740,6 +740,14 @@ the removal will be in 0.(x+2). For example, if the deprecation happened | |||
| in version 0.18-dev, the message should say it happened in version 0.18 | |||
| and the old behavior will be removed in version 0.20. | |||
|
|
|||
| In addition, a deprecation note should be added in the docstring, recalling the | |||
| same information as the deprecation warning as explained above. Use the | |||
| ``.. deprecated::`` tag:: | |||
There was a problem hiding this comment.
I would double-check the terminology here. I think sphinx called this a "directive" rather than a "tag".
There was a problem hiding this comment.
yep, it is a directive (http://www.sphinx-doc.org/en/stable/markup/para.html)
|
Done! |
|
LGTM, merging! Note the AppVeyor is a transient failure we are seeing from time to time. |
|
Thanks! |
Sundrique
pushed a commit
to Sundrique/scikit-learn
that referenced
this pull request
Jun 14, 2017
Update developers doc to use "deprecated" sphinx directive.
dmohns
pushed a commit
to dmohns/scikit-learn
that referenced
this pull request
Aug 7, 2017
Update developers doc to use "deprecated" sphinx directive.
dmohns
pushed a commit
to dmohns/scikit-learn
that referenced
this pull request
Aug 7, 2017
Update developers doc to use "deprecated" sphinx directive.
NelleV
pushed a commit
to NelleV/scikit-learn
that referenced
this pull request
Aug 11, 2017
Update developers doc to use "deprecated" sphinx directive.
paulha
pushed a commit
to paulha/scikit-learn
that referenced
this pull request
Aug 19, 2017
Update developers doc to use "deprecated" sphinx directive.
AishwaryaRK
pushed a commit
to AishwaryaRK/scikit-learn
that referenced
this pull request
Aug 29, 2017
Update developers doc to use "deprecated" sphinx directive.
maskani-moh
pushed a commit
to maskani-moh/scikit-learn
that referenced
this pull request
Nov 15, 2017
Update developers doc to use "deprecated" sphinx directive.
jwjohnson314
pushed a commit
to jwjohnson314/scikit-learn
that referenced
this pull request
Dec 18, 2017
Update developers doc to use "deprecated" sphinx directive.
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 Issue
Fixes #8904
Fixes #8903
What does this implement/fix? Explain your changes.
Add in the documentation how to announce deprecation in docstring.
Change all deprecation announcements to make them homogeneous.
Any other comments?