Skip to content

DOC Add version_added label for impute module#15549

Merged
glemaitre merged 6 commits intoscikit-learn:masterfrom
TwsThomas:update_version_added
Jan 9, 2020
Merged

DOC Add version_added label for impute module#15549
glemaitre merged 6 commits intoscikit-learn:masterfrom
TwsThomas:update_version_added

Conversation

@TwsThomas
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes partially #15426

What does this implement/fix? Explain your changes.

Update the version added tag for the imputer class.

Any other comments?

Might be part of the PR #15482 ?


Read more in the :ref:`User Guide <impute>`.

.. versionadded:: 0.14
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.

This has only been available as SimpleImputer since 0.20

versionadded helps users understand whether the same tool can be imported in different versions, so the fact that the functionality existed since 0.14 is irrelevant

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That's clear.
Maybe we could mention it ? with something like:

Suggested change
.. versionadded:: 0.14
.. versionadded:: 0.20
Moved from Imputer in sklearn.preprocessing.

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.

At first, I was not convinced about mentioning this detail. But after seeing a lot of SO question, I think this worth mentioning something.

.. versionadded:: 0.20
   `SimpleImputer` replaces the previous `sklearn.preprocessing.Imputer`
   estimator which is now removed.

@glemaitre glemaitre changed the title [DOC] Add version_added label for imputer class DOC Add version_added label for imputer class Jan 9, 2020
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

@TwsThomas Could you make the change I think that we could merge it after.

@glemaitre glemaitre changed the title DOC Add version_added label for imputer class DOC Add version_added label for impute module Jan 9, 2020
@glemaitre glemaitre self-requested a review January 9, 2020 14:24
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. Waiting for the CI to be merged.

@glemaitre glemaitre merged commit 4fe4d27 into scikit-learn:master Jan 9, 2020
@glemaitre
Copy link
Copy Markdown
Member

Thanks @TwsThomas

thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Feb 22, 2020
panpiort8 pushed a commit to panpiort8/scikit-learn that referenced this pull request Mar 3, 2020
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.

3 participants