[MRG] Label docstrings with versionadded #15426 - classes starting with 'p' #15494
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
…n, PLSSVD, PatchExtractor, Pipeline, PowerTransformer, PredefinedSplit (Issue scikit-learn#15426)
TomDLT
reviewed
Nov 2, 2019
| @@ -2715,6 +2715,8 @@ class PowerTransformer(TransformerMixin, BaseEstimator): | |||
|
|
|||
| .. [2] G.E.P. Box and D.R. Cox, "An Analysis of Transformations", Journal | |||
| of the Royal Statistical Society B, 26, 211-252 (1964). | |||
|
|
|||
| .. versionadded:: 0.19.2 | |||
There was a problem hiding this comment.
Is there a reason you specified 0.19.2 as opposed to 0.19 ?
There was a problem hiding this comment.
I double checked, and it seems to have been added in 0.20, as stated in the doc/whats_new/v0.20.rst file (here). Where did you find the 0.19.2 mention ?
|
That was the version specified in the .rst file.
…On Sat, Nov 2, 2019 at 2:41 PM Tom Dupré la Tour ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In sklearn/preprocessing/_data.py
<#15494 (comment)>
:
> @@ -2715,6 +2715,8 @@ class PowerTransformer(TransformerMixin, BaseEstimator):
.. [2] G.E.P. Box and D.R. Cox, "An Analysis of Transformations", Journal
of the Royal Statistical Society B, 26, 211-252 (1964).
+
+ .. versionadded:: 0.19.2
Is there a reason you specified 0.19.2 as opposed to 0.19 ?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#15494?email_source=notifications&email_token=AFJINPXKZ2KVCXJSC4ZFTGLQRXXXLA5CNFSM4JIH34UKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCKDENFY#pullrequestreview-310789783>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AFJINPXA26XMALAKBHIGAX3QRXXXLANCNFSM4JIH34UA>
.
|
TomDLT
approved these changes
Nov 2, 2019
|
which rst file are you talking about ? |
jnothman
reviewed
Nov 3, 2019
| @@ -634,6 +634,8 @@ class PLSRegression(_PLS): | |||
| In french but still a reference: | |||
| Tenenhaus, M. (1998). La regression PLS: theorie et pratique. Paris: | |||
| Editions Technic. | |||
|
|
|||
| .. versionadded:: 0.8 | |||
There was a problem hiding this comment.
These need to be added after the description, before parameters. Adding it here will be a problem with numpydoc
|
@rth is it possible to remove the "Needs work" label from this PR since it is now closed? |
|
I removed the tag |
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
Label docstrings with versionadded #15426
What does this implement/fix? Explain your changes.
Documentation changes - added 'versionadded' to following classes:
PLSCanonical, PLSRegression, PLSSVD, PatchExtractor, Pipeline, PowerTransformer, PredefinedSplit
Any other comments?
Exact versions were identified using the whats_new documentation. If a class was not present in the versions file, the version was extracted from the module creation.