Skip to content

DOC improve docstring of covariance module following doc guideline #16105

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jan 15, 2020
Merged

DOC improve docstring of covariance module following doc guideline #16105

merged 5 commits into from
Jan 15, 2020

Conversation

mghah
Copy link
Contributor

@mghah mghah commented Jan 12, 2020

Reference Issues/PRs

related to #15761

What does this implement/fix? Explain your changes.

improves docstring for all Classes and Functions under sklearn.covariance module per guidelines

@mghah mghah mentioned this pull request Jan 12, 2020
Closed
@glemaitre
Copy link
Member

can you check the linting error

@glemaitre
Copy link
Member

Regarding the range, I would suggest to only add it in the description of the parameter:

param : int, default=0.5
    Something about the parameter. The expected range is (0, 1[.

@mghah
Copy link
Contributor Author

mghah commented Jan 14, 2020 •
edited
Loading

@glemaitre, I made improvements based on your suggestion. I put parameter ranges in the docstring after explanations. Also fixed linting errors. Thanks!

@glemaitre glemaitre self-requested a review January 15, 2020 10:18
glemaitre
glemaitre approved these changes Jan 15, 2020
View reviewed changes
Copy link
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. I pushed changes in the methods as well.
Will merge when CIs are green.

@glemaitre glemaitre changed the title [DOC] docstring improvement for covariance module DOC improve docstring of covariance module following doc guideline Jan 15, 2020
@glemaitre glemaitre merged commit 999f288 into scikit-learn:master Jan 15, 2020
@glemaitre
Copy link
Member

Thanks @mghah

@mghah mghah deleted the add-mo branch January 16, 2020 05:44
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Feb 22, 2020
@mghah @thomasjpfan
DOC improve docstring of covariance module following doc guideline (s…
c31c80f 
…cikit-learn#16105)
panpiort8 pushed a commit to panpiort8/scikit-learn that referenced this pull request Mar 3, 2020
@mghah
DOC improve docstring of covariance module following doc guideline (s…
fe78858 
…cikit-learn#16105)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre glemaitre approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mghah @glemaitre