Skip to content

[MRG] Label docstrings with versionadded #15426 - classes starting with 'p'#15494

Closed
harini-sridhar wants to merge 2 commits intoscikit-learn:masterfrom
harini-sridhar:15426_docstring_P
Closed

[MRG] Label docstrings with versionadded #15426 - classes starting with 'p'#15494
harini-sridhar wants to merge 2 commits intoscikit-learn:masterfrom
harini-sridhar:15426_docstring_P

Conversation

@harini-sridhar
Copy link
Copy Markdown

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.

.. [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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason you specified 0.19.2 as opposed to 0.19 ?

Copy link
Copy Markdown
Member

@TomDLT TomDLT Nov 2, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ?

@harini-sridhar
Copy link
Copy Markdown
Author

harini-sridhar commented Nov 2, 2019 via email

@TomDLT
Copy link
Copy Markdown
Member

TomDLT commented Nov 2, 2019

which rst file are you talking about ?

Tenenhaus, M. (1998). La regression PLS: theorie et pratique. Paris:
Editions Technic.

.. versionadded:: 0.8
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These need to be added after the description, before parameters. Adding it here will be a problem with numpydoc

@reshamas
Copy link
Copy Markdown
Member

@rth is it possible to remove the "Needs work" label from this PR since it is now closed?

@glemaitre
Copy link
Copy Markdown
Member

I removed the tag

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants