8000 [WIP] Add Versionadded tags by J0 · Pull Request #12187 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

[WIP] Add Versionadded tags #12187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2018
Merged

[WIP] Add Versionadded tags #12187

merged 1 commit into from
Sep 28, 2018

Conversation

J0
Copy link
Contributor
@J0 J0 commented Sep 28, 2018

Reference Issues/PRs

Fixes #12081.

What does this implement/fix? Explain your changes.

This PR adds adds tags to track the version of each function

Any other comments?

@J0 J0 changed the title [WIP] Add Versionadded tag to sklearn/_config.py [WIP] Add Versionadded tags Sep 28, 2018
@@ -36,6 +36,8 @@ def set_config(assume_finite=None, working_memory=None):
to this number of MiB (per job when parallelised), often saving both
computation time and memory on expensive operations that can be
performed in chunks. Global default: 1024.

.. versionadded:: 0.19
Copy link
Member

Choose a reason for hiding this comment

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

It was in 0.20.

Copy link
Member

Choose a reason for hiding this comment

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

It makes more sense to document each parameter than the overall function.

Copy link
Member

Choose a reason for hiding this comment

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

It makes more sense to document each parameter than the overall function.

Honestly this is exactly what I prefer, not sure whether Andreas will agree with us. @jnothman should I push a commit or let's leave it as it is?

Copy link
Member

Choose a reason for hiding this comment

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

I guess I would do both, but yes, parameters seems more important.

@qinhanmin2014
Copy link
Member

@rth It's added in 0.19. Previously, it's in sklearn/__init__.py, see
https://github.com/scikit-learn/scikit-learn/blob/0.19.X/sklearn/__init__.py#L40
ee88cf4

Copy link
Member
@qinhanmin2014 qinhanmin2014 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @leeyjjoel

@qinhanmin2014 qinhanmin2014 merged commit a358d7d into scikit-learn:master Sep 28, 2018
@rth
Copy link
Member
rth commented Sep 28, 2018

You are right @qinhanmin2014, parameter were added later..

@qinhanmin2014
Copy link
Member

Sigh, the format is not correct and we put it in the wrong place. Apologies for merging this one. I'll push a commit to fix it.

@qinhanmin2014
Copy link
Member

I guess I would do both, but yes, parameters seems more important.

Fine, I think this will be a good solution here. Will push a commit.

jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request Oct 15, 2018
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.

set_config has no versionadded
5 participants
0