Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Ensure additive_chi2_kernel passes numpydoc validation #23943

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 10 commits into from
Jul 19, 2022
Merged

DOC Ensure additive_chi2_kernel passes numpydoc validation #23943

merged 10 commits into from
Jul 19, 2022
+9 −10

Conversation

Mathews-Tom
Copy link
Contributor

Reference Issues/PRs
Address #21350

What does this implement/fix? Explain your changes.

  1. Remove sklearn.metrics.pairwise.additive_chi2_kernelfrom test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST.
  2. Fix the following:
    • GL03: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
    • GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, Notes, References
    • SS05: Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")
    • SS06: Summary should fit in a single line
    • PR07: Parameter "X" has no description
    • RT03: Return value has no description

@Mathews-Tom
Remove additive_chi2_kernel from test ignore list.
fccc4a4
@Mathews-Tom
Fix doc validation errors for additive_chi2_kernel.
c7c6acd 
- Remove double line break between sections.
- Reorder sections.
- Restructure summary to fit in a single line.
- Add description to Parameter "X".
- Add description to Return value.
jeremiedbb
jeremiedbb reviewed Jul 19, 2022
View reviewed changes
Copy link
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @Mathews-Tom. I made some suggestions to keep local consistency with other kernels defined in this file

jeremiedbb
jeremiedbb approved these changes Jul 19, 2022
View reviewed changes
Copy link
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @Mathews-Tom

@jeremiedbb jeremiedbb merged commit e1cba05 into scikit-learn:main Jul 19, 2022
@thomasjpfan thomasjpfan mentioned this pull request Jul 19, 2022
Closed
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.pairwise branch July 19, 2022 19:58
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
@Mathews-Tom @jeremiedbb @glemaitre
DOC Ensure additive_chi2_kernel passes numpydoc validation (scikit-…
a56563a 
…learn#23943)

Co-authored-by: Jérémie du Boisberranger <[email protected]>
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
@Mathews-Tom @jeremiedbb @glemaitre
DOC Ensure additive_chi2_kernel passes numpydoc validation (#23943)
d2e3f53 
Co-authored-by: Jérémie du Boisberranger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeremiedbb jeremiedbb jeremiedbb approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@Mathews-Tom @jeremiedbb