Skip to content

DOC Ensures that BernoulliNB passes numpydoc validation #20429

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 63 commits into from
Jul 1, 2021
Merged

DOC Ensures that BernoulliNB passes numpydoc validation #20429

merged 63 commits into from
Jul 1, 2021

Conversation

genvalen
Copy link
Contributor

@genvalen genvalen commented Jun 30, 2021 •
edited
Loading

Reference Issues/PRs

Addresses #20308
#dataumbrella sprint
cc: @j3nnn1

What does this implement/fix? Explain your changes.

Added more NB classes to the "See Also" section of BernoulliNB.
Edit: Fixed errors to help file pass numpydoc validation

Any other comments?

genvalen and others added 30 commits June 6, 2020 16:02
@genvalen
Update default doc string values
1a7f2fb
@genvalen
Update default docstrings for Metrics
ca94a79
@genvalen
Fix lint error
cc09f9d
@genvalen
Merge remote-tracking branch 'upstream/master' into linear-model-defa…
a899bef 
…ult-docs
@genvalen
Resolve merge conflicts
c8cd424
@genvalen
Fix flake8 error
da935ac
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
bede6d0 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @adrinjalali
Update sklearn/metrics/_classification.py
7b4647e 
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_base.py
cfe8b2b 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @adrinjalali
Update sklearn/metrics/_classification.py
1ec16e8 
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
5e52205 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
8df195e 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/pairwise.py
c93effd 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/pairwise.py
57ca202 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/pairwise.py
3937592 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/pairwise.py
a069d00 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/pairwise.py
a82ee38 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
572ca85 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
89af371 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
601c757 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
4ed3830 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
1fa4425 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
48a5908 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
881f733 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
c85c836 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
9286fcb 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_ranking.py
8367323 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
056c8e9 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
036b8b6 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen @glemaitre
Update sklearn/metrics/_classification.py
1a83796 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen genvalen changed the title [WIP] DOC Ensures that BernoulliNB passes numpydoc validation DOC Ensures that BernoulliNB passes numpydoc validation Jun 30, 2021
@genvalen genvalen marked this pull request as ready for review June 30, 2021 13:51
@genvalen genvalen marked this pull request as draft June 30, 2021 14:25
@genvalen genvalen marked this pull request as ready for review June 30, 2021 14:32
ogrisel
ogrisel approved these changes Jun 30, 2021
View reviewed changes
Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming the trailing space clean-up will make the CI linter pass, here are few other suggestions but other than that LGTM!

genvalen and others added 3 commits June 30, 2021 13:28
@genvalen @ogrisel
Update sklearn/naive_bayes.py
c222189 
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
@genvalen @ogrisel
Update sklearn/naive_bayes.py
a60879c 
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
@genvalen @ogrisel
Update sklearn/naive_bayes.py
7c30000 
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
@genvalen
Copy link
Contributor Author

Assuming the trailing space clean-up will make the CI linter pass, here are few other suggestions but other than that LGTM!

I accepted the changes. Thanks for reviewing this PR and the last!

@genvalen genvalen closed this Jun 30, 2021
@genvalen genvalen deleted the bernouliNB_numpy_doc branch June 30, 2021 20:03
@genvalen genvalen restored the bernouliNB_numpy_doc branch June 30, 2021 20:06
@genvalen genvalen deleted the bernouliNB_numpy_doc branch June 30, 2021 20:14
@genvalen genvalen restored the bernouliNB_numpy_doc branch June 30, 2021 23:05
@genvalen genvalen reopened this Jun 30, 2021
thomasjpfan
thomasjpfan reviewed Jul 1, 2021
View reviewed changes
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR @genvalen !

REF: #20308 (comment)

genvalen and others added 3 commits June 30, 2021 20:42
@genvalen @thomasjpfan
Update sklearn/naive_bayes.py
cfb8f21 
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
@genvalen @thomasjpfan
Update sklearn/naive_bayes.py
5d2cb55 
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
@genvalen @thomasjpfan
Update sklearn/naive_bayes.py
8c782ba 
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
@thomasjpfan thomasjpfan merged commit e4ef854 into scikit-learn:main Jul 1, 2021
@genvalen genvalen deleted the bernouliNB_numpy_doc branch July 1, 2021 02:34
This was referenced Jul 23, 2021
Merged
Closed
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
@genvalen @glemaitre
@adrinjalali @ogrisel @thomasjpfan @samronsin
DOC Ensures that BernoulliNB passes numpydoc validation (scikit-learn…
1c3d77c 
…#20429)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ogrisel ogrisel ogrisel approved these changes

@thomasjpfan thomasjpfan thomasjpfan approved these changes

Assignees
No one assigned
Labels
Documentation module:metrics module:naive_bayes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@genvalen @ogrisel @thomasjpfan