Skip to content

DOC Ensures that PassiveAggressiveClassifier passes numpydoc validation #21226

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 2 commits into from
Oct 12, 2021
Merged

DOC Ensures that PassiveAggressiveClassifier passes numpydoc validation #21226

merged 2 commits into from
Oct 12, 2021

Conversation

ovynnej
Copy link
Contributor

@ovynnej ovynnej commented Oct 2, 2021

Reference Issues/PRs

Addresses #20308.

What does this implement/fix? Explain your changes.

I made fixes to the docstrings in _passive_aggressive.py, but one test is still failling.

Any other comments?

I would be grateful for help with this final failing test: Running pytest maint_tools/test_docstrings.py -k PassiveAggressiveClassifier- gives me SS03: Summary does not end with a period.

I visually combed through the _passive_aggressive.py and added periods to the end of all summaries. I don't think there are any summaries left without periods. Is there something I'm missing? And is there some way to run pytest maint_tools/test_docstrings.py such that it prints out the line numbers of the errors? I tried using flake8, the other style tool I know, but it returns no errors.

Thank you!

@glemaitre
Copy link
Member

Just a quick pass to say that the CI is still failing. I think that there is still a couple of changes to do:
https://dev.azure.com/scikit-learn/scikit-learn/_build/results?buildId=33206&view=logs&jobId=78a0bf4f-79e5-5387-94ec-13e67d216d6e&j=78a0bf4f-79e5-5387-94ec-13e67d216d6e&t=dbc16e8a-e84c-5cb6-14f6-590d872d6e0b

@ovynnej
Copy link
Contributor Author

ovynnej commented Oct 5, 2021

Hello @glemaitre! Yes, pytest maint_tools/test_docstrings.py -k PassiveAggressiveClassifier- is still giving me SS03: Summary does not end with a period. I'm stumped because I have checked that I added periods to the end of all summaries in _passive_aggressive.py. Do you know whether there is some way to run pytest maint_tools/test_docstrings.py such that it prints out the line numbers of the errors? I'd be grateful for any tips. Thank you!

@glemaitre glemaitre self-assigned this Oct 12, 2021
@glemaitre
Copy link
Member

It was missing a final full stop in the summary. I pushed the changes to solve the issue.

@glemaitre glemaitre merged commit 682bd05 into scikit-learn:main Oct 12, 2021
@glemaitre
Copy link
Member

Merging @ovynnej Thanks

@ovynnej
Copy link
Contributor Author

ovynnej commented Oct 12, 2021

Thank you @glemaitre!

@ovynnej ovynnej deleted the passive-aggressive-classifer branch October 12, 2021 20:59
@glemaitre glemaitre mentioned this pull request Oct 23, 2021
Merged
10 tasks
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Oct 23, 2021
@ovynnej @glemaitre
DOC Ensures that PassiveAggressiveClassifier passes numpydoc validati…
650bbe0 
…on (scikit-learn#21226)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit that referenced this pull request Oct 25, 2021
@ovynnej @glemaitre
DOC Ensures that PassiveAggressiveClassifier passes numpydoc validati…
2ae7a3a 
…on (#21226)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
@ovynnej @glemaitre @samronsin
DOC Ensures that PassiveAggressiveClassifier passes numpydoc validati…
8d61582 
…on (scikit-learn#21226)

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
No reviews
Assignees

@glemaitre glemaitre

Labels
Documentation module:linear_model
Projects
None yet
Milestone
No milestone
Development

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