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

Skip to content

DOC Ensure chi2_kernel passes numpydoc validation #23945

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.chi2_kernelfrom test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST.
  2. Fix the following:
    • SS05: Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")
    • PR07: Parameter "X" has no description
    • PR07: Parameter "Y" has no description
    • PR05: Parameter "gamma" type should not finish with "."
    • RT03: Return value has no description

- Modify summary to start with infinitive verb.
- Add description to Parameter "X".
- Add description to Parameter "Y".
- Remove full stop from Parameter "gamma" type.
- 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. Here are some suggestions to keep local consistency

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 @Mathews-Tom

@jeremiedbb jeremiedbb merged commit 6d4c653 into scikit-learn:main Jul 19, 2022
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.pairwise.chi2_kernel branch July 19, 2022 15:18
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.

2 participants