Skip to content

DOC improve random_state docstrings in the linear_model module#11900

Merged
glemaitre merged 7 commits intoscikit-learn:masterfrom
SirR4T:docs-for-random_state-linear_model
Jan 8, 2020
Merged

DOC improve random_state docstrings in the linear_model module#11900
glemaitre merged 7 commits intoscikit-learn:masterfrom
SirR4T:docs-for-random_state-linear_model

Conversation

@SirR4T
Copy link
Copy Markdown
Contributor

@SirR4T SirR4T commented Aug 23, 2018

Reference Issues/PRs

Working towards #10548.

What does this implement/fix? Explain your changes.

Updates the docstrings for random_state parameter, to point towards the Glossary page for the same term, instead of duplicating the explanation everywhere.

This PR deals with the linear_model module only.

Any other comments?

For `linear_model` module.
Working towards scikit-learn#10548.
Sarat Addepalli and others added 3 commits August 23, 2018 17:40
to specify that passing ints can achieve reproducible outputs
across multiple function calls.
@thomasjpfan
Copy link
Copy Markdown
Member

We tend to currently prefer:

random_state : int, RandomState instance or None, optional (default=None)

although I would like this someday:

random_state : int, RandomState instance, or None (default=None)

@rth rth added help wanted Stalled good first issue Easy with clear instructions to resolve labels Jul 18, 2019
@glemaitre glemaitre self-requested a review January 8, 2020 15:34
@glemaitre
Copy link
Copy Markdown
Member

I solve the conflict and just apply the new formatting style

@glemaitre glemaitre changed the title [MRG] Fix random_state docstrings to refer Glossary DOC improve random_state docstrings in the linear_model module Jan 8, 2020
@glemaitre glemaitre merged commit 7898d6b into scikit-learn:master Jan 8, 2020
@glemaitre
Copy link
Copy Markdown
Member

@SirR4T Thanks for your contribution. Sorry that it took so long to agree on the styling.

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

good first issue Easy with clear instructions to resolve help wanted Stalled

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants