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

Skip to content

DOC Ensure sigmoid_kernel passes numpydoc validation #23955

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.sigmoid_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 "coef0" has no description
    • RT03: Return value has no description

- Add period at the end of summary.
- Add description for parameter "X".
- Add description for parameter "coef0".
- Add description for return value.
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

Co-authored-by: Jérémie du Boisberranger <[email protected]>
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thank you for the PR!

Mathews-Tom and others added 2 commits July 20, 2022 09:46
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, thanks for the PR! Left feedback on some minor wording. My comments for gamma and coef0 are the same as in your other PR #23953, so if we reach a concensus in one PR it should be applied in all relevant PRs (e.g. accept/reject this expanded description).

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

Co-authored-by: Jérémie du Boisberranger <[email protected]>
Co-authored-by: Thomas J. Fan <[email protected]>
Co-authored-by: Meekail Zain <[email protected]>
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
Co-authored-by: Jérémie du Boisberranger <[email protected]>
Co-authored-by: Thomas J. Fan <[email protected]>
Co-authored-by: Meekail Zain <[email protected]>
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.

4 participants