Skip to content
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.

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

DOC ensure Naive Bayes classes passes numpydoc validation #20440

Merged
merged 67 commits into from
Jul 13, 2021

Conversation

genvalen
Copy link
Contributor

@genvalen genvalen commented Jul 2, 2021

Reference Issues/PRs

Addresses #20439 and #20308
#DataUmbrella Sprint

What does this implement/fix? Explain your changes.

Any other comments?

I updated every class except BernoulliNB (#20429)

Edit: Ensured the following classes pass numpydoc validation: GaussianNB, MultinominalNB, ComplementNB; CategoricalNB already passing, but updated 'see also section.

genvalen and others added 30 commits June 6, 2020 16:02
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@glemaitre glemaitre changed the title Update Naive Bayes classes with see also section and cross reference other NB classes for each DOC ensure Naive Bayes classes passes numpydoc validation Jul 6, 2021
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.

Could you remove the Naive Bayes classes from the list that skip the numpydoc validation.
I would prefer to make a single PR that also check the full docstring and not to change only the See Also part.

@genvalen
Copy link
Contributor Author

genvalen commented Jul 6, 2021

Could you remove the Naive Bayes classes from the list that skip the numpydoc validation.
I would prefer to make a single PR that also check the full docstring and not to change only the See Also part.

Yep! I'll work on this.

@glemaitre glemaitre self-requested a review July 7, 2021 08:25
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.

A couple of small change

sklearn/naive_bayes.py Outdated Show resolved Hide resolved
sklearn/naive_bayes.py Outdated Show resolved Hide resolved
sklearn/naive_bayes.py Outdated Show resolved Hide resolved
sklearn/naive_bayes.py Outdated Show resolved Hide resolved
genvalen and others added 4 commits July 7, 2021 13:22
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@genvalen genvalen requested a review from glemaitre July 7, 2021 17:25
@thomasjpfan
Copy link
Member

@genvalen To fix the circleCI, may you merge with upstream/main?

@glemaitre glemaitre merged commit 3fd2925 into scikit-learn:main Jul 13, 2021
@glemaitre
Copy link
Member

All good @genvalen Thanks. Merging.

@genvalen genvalen deleted the update_NB_classes branch August 22, 2021 03:49
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…rn#20440)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants