Skip to content

DOC Ensure sigmoid_kernel passes numpydoc validation#23955

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

DOC Ensure sigmoid_kernel passes numpydoc validation#23955
jeremiedbb merged 9 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.sigmoid_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.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
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

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Copy link
Copy Markdown
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
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Copy link
Copy Markdown
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).

Mathews-Tom and others added 4 commits July 21, 2022 00:37
Co-authored-by: Meekail Zain <34613774+Micky774@users.noreply.github.com>
Co-authored-by: Meekail Zain <34613774+Micky774@users.noreply.github.com>
Co-authored-by: Meekail Zain <34613774+Micky774@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 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 <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Co-authored-by: Meekail Zain <34613774+Micky774@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>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Co-authored-by: Meekail Zain <34613774+Micky774@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.

4 participants