Skip to content

DOC Ensure additive_chi2_kernel passes numpydoc validation#23943

Merged
jeremiedbb merged 10 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise
Jul 19, 2022
Merged

DOC Ensure additive_chi2_kernel passes numpydoc validation#23943
jeremiedbb merged 10 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise

Conversation

@Mathews-Tom
Copy link
Copy Markdown
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

- 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.
Copy link
Copy Markdown
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

Mathews-Tom and others added 5 commits July 19, 2022 17:24
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Copy link
Copy Markdown
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
@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
…learn#23943)

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.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.

2 participants