Skip to content

DOC improve svm module docstring per guidlines #16060

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 4 commits into from
Jan 9, 2020
Merged

DOC improve svm module docstring per guidlines #16060

merged 4 commits into from
Jan 9, 2020

Conversation

tituschristian
Copy link
Contributor

@tituschristian tituschristian commented Jan 8, 2020 •
edited
Loading

Reference Issues/PRs

Improve sklearn/svm module per guidlines https://scikit-learn.org/stable/developers/contributing.html#guidelines-for-writing-documentation
See also #15761

@tituschristian tituschristian changed the title DOC improve svm module docstring per guidlines DOC improve svm module docstring per guidlines Jan 8, 2020
@glemaitre
Copy link
Member

@tituschristian CIs are failing due to some PEP8 issue probably. Could you check that.

@tituschristian
Copy link
Contributor Author

tituschristian commented Jan 9, 2020 •
edited
Loading

Updated.
Sorry, missed some whitespace

@glemaitre glemaitre self-requested a review January 9, 2020 14:36
glemaitre
glemaitre approved these changes Jan 9, 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.

I pushed some changes to correct when you introduced array-like instead of ndarray.
Basically, array-like can be several types (list, array, etc.) then a return type cannot be a array-like but will be a specific numpy array (ndarray).

Otherwise, LGTM. I am going to merge it.

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

@tituschristian Thanks for contributing.

@glemaitre glemaitre mentioned this pull request Jan 9, 2020
Closed
@tituschristian
Copy link
Contributor Author

@glemaitre Thanks for your feedback.

@tituschristian tituschristian deleted the updatedocstring branch January 9, 2020 18:58
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jan 10, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
653fb82
@judithabk6 judithabk6 mentioned this pull request Jan 28, 2020
Closed
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jan 30, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
98202f9
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jan 30, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
c8886f1
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Feb 22, 2020
@tituschristian @thomasjpfan
DOC improve svm module docstring per guidlines (scikit-learn#16060)
fc28291
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Feb 27, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
0000ef6
panpiort8 pushed a commit to panpiort8/scikit-learn that referenced this pull request Mar 3, 2020
@tituschristian
DOC improve svm module docstring per guidlines (scikit-learn#16060)
b73cb62
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Mar 12, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
88d8961
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Apr 17, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
d2ff7bd
ivannz added a commit to ivannz/scikit-learn that referenced this pull request May 3, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
65cde50
ivannz added a commit to ivannz/scikit-learn that referenced this pull request May 30, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
592c8d1
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jul 5, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
1d26372
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jul 5, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
aadac2e
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Aug 5, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
bd32690
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Oct 15, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
138cf15
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Nov 28, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
ca8a991
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Dec 12, 2020
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
0ddc2b6
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Feb 25, 2021
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
c278025
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Feb 25, 2021
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
92c8925
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Mar 27, 2021
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
57d7a09
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jun 15, 2021
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
842f89d
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jul 23, 2021
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
bc7dada
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Nov 10, 2021
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
34d607d
ivannz added a commit to ivannz/scikit-learn that referenced this pull request May 15, 2022
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
ef42b44
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Jun 14, 2022
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
09be9da
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Aug 29, 2022
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
6dcddfb
ivannz added a commit to ivannz/scikit-learn that referenced this pull request Sep 5, 2022
@ivannz
DOC new docstring guidelines in svdd (according to scikit-learn#16060)
fab4538
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
@tituschristian @glemaitre