Skip to content

DOC Ensures that SVC passes numpydoc validation#20457

Merged
glemaitre merged 13 commits intoscikit-learn:mainfrom
jmloyola:fix_numpydoc_svc
Jul 13, 2021
Merged

DOC Ensures that SVC passes numpydoc validation#20457
glemaitre merged 13 commits intoscikit-learn:mainfrom
jmloyola:fix_numpydoc_svc

Conversation

@jmloyola
Copy link
Copy Markdown
Member

@jmloyola jmloyola commented Jul 3, 2021

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

This PR ensures SVC is compatible with numpydoc.

  • Remove SVC from DOCSTRING_IGNORE_LIST.
  • Verify all tests passing.

Any other comments?

#DataUmbrella Sprint

This was referenced Jul 3, 2021
Merged
Merged
glemaitre
glemaitre requested changes Jul 6, 2021
View reviewed changes
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.

Just a couple of changes in the property docstring. Could you merge main into your branch?

jmloyola and others added 5 commits July 6, 2021 09:27
@jmloyola @glemaitre
Update sklearn/svm/_base.py
7b9fd53 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola @glemaitre
Update sklearn/svm/_base.py
4d484ad 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola @glemaitre
Update sklearn/svm/_base.py
049e6ae 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola @glemaitre
Update sklearn/svm/_base.py
7789f51 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola
Merge upstream/main into fix_numpydoc_svc
d65436e
@jmloyola
Copy link
Copy Markdown
Member Author

jmloyola commented Jul 6, 2021

Thanks for the comments @glemaitre.
I merged upstream/main into this branch.
Let me know if there is something else I should do.

@jmloyola
Copy link
Copy Markdown
Member Author

jmloyola commented Jul 6, 2021

@glemaitre, how should we document the properties?
After the suggestions, the numpydoc validation throws this error for all docstrings of the properties:
- SS02: Summary does not start with a capital letter

jmloyola
jmloyola commented Jul 6, 2021
View reviewed changes
@thomasjpfan thomasjpfan mentioned this pull request Jul 6, 2021
Closed
@thomasjpfan
Copy link
Copy Markdown
Member

thomasjpfan commented Jul 10, 2021

To fix the circleci issues, you need to merge upstream/main into this PR.

@jmloyola
Copy link
Copy Markdown
Member Author

jmloyola commented Jul 10, 2021

I think this PR is ready. But, obviously, any suggestions are more than welcome 🤓.

Let me know what you think @thomasjpfan, @amueller, @glemaitre

@jmloyola jmloyola requested a review from glemaitre July 12, 2021 12:56
glemaitre
glemaitre requested changes Jul 13, 2021
View reviewed changes
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.

A couple of more changes

jmloyola and others added 4 commits July 13, 2021 08:59
@jmloyola @glemaitre
Update sklearn/svm/_base.py
ed8f6e8 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola @glemaitre
Update sklearn/svm/_base.py
914cab5 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola @glemaitre
Update sklearn/svm/_base.py
0d7cf21 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola @glemaitre
Update sklearn/svm/_base.py
c1dda10 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola
Copy link
Copy Markdown
Member Author

jmloyola commented Jul 13, 2021

Thank you @glemaitre for the comments, let me know if there is something else that I need to do.

@glemaitre glemaitre merged commit 9c2b3b6 into scikit-learn:main Jul 13, 2021
@glemaitre
Copy link
Copy Markdown
Member

glemaitre commented Jul 13, 2021

All good. Thanks @jmloyola we can merge.

@jmloyola jmloyola deleted the fix_numpydoc_svc branch July 13, 2021 16:22
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
@jmloyola @glemaitre @samronsin
DOC Ensures that SVC passes numpydoc validation (scikit-learn#20457)
8defc3f 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@amueller amueller amueller left review comments

@glemaitre glemaitre glemaitre requested changes

Assignees

No one assigned

Labels

Documentation module:svm

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jmloyola @thomasjpfan @glemaitre @amueller