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

Skip to content

DOC Ensure polynomial_kernel passes numpydoc validation #23953

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

Conversation

Mathews-Tom
Copy link
Contributor

Reference Issues/PRs
Address #21350

What does this implement/fix? Explain your changes.

  1. Remove sklearn.metrics.pairwise.polynomial_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
    • PR07: Parameter "Y" has no description
    • PR07: Parameter "degree" has no description
    • PR07: Parameter "coef0" has no description
    • RT03: Return value has no description

- Add period at the end of summary.
- Add description to parameter "X".
- Add description to parameter "Y".
- Add description to parameter "degree".
- Add description to parameter "coef0".
- Add description to return value.
- Add period at the end of summary.
- Add description to parameter "X".
- Add description to parameter "Y".
- Add description to parameter "degree".
- Add description to parameter "coef0".
- Add description to return value.
Copy link
Contributor

@Micky774 Micky774 left a comment

Choose a reason for hiding this comment

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

Hey there @Mathews-Tom, thank you for the PR! I left a comment on how to fix the current failing test, and a few small suggestions regarding wording. Please let me know if you have any questions or concerns.

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