Skip to content

DOC Ensure rbf_kernel passes numpydoc validation#23954

Merged
jeremiedbb merged 3 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.rbf_kernel
Jul 21, 2022
Merged

DOC Ensure rbf_kernel passes numpydoc validation#23954
jeremiedbb merged 3 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.rbf_kernel

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.rbf_kernelfrom test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST.
  2. Fix the following:
    • SS03: Summary does not end with a period
    • PR07: Parameter "X" has no description
    • RT03: Return value has no description

- Add period at the end of summary.
- Add description for parameter "X".
- Add description for 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 just have 1 remark

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 095e466 into scikit-learn:main Jul 21, 2022
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.pairwise.rbf_kernel branch July 22, 2022 10:09
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
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