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

Skip to content

DOC Ensure that ndcg_score passes numpydoc validation #22400

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

Merged

Conversation

Kim2212
Copy link
Contributor

@Kim2212 Kim2212 commented Feb 7, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

This PR fixes the following errors that were appearing for numpydoc validation for sklearn.metrics._ranking.ndcg_score:

  • GL03: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings (remove blank line at the end of the docstring)
  • YD01: No Yields section found (replace yields with returns)
  • Remove the function from the list FUNCTION_DOCSTRING_IGNORE_LIST

@thomasjpfan thomasjpfan changed the title DOC Ensure that sklearn.metrics._ranking.ndcg_score passes numpydoc validation DOC Ensure that sklearn.metrics._ranking.ndcg_score passes numpydoc validation Feb 7, 2022
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 @Kim2212 ! LGTM

@thomasjpfan thomasjpfan changed the title DOC Ensure that sklearn.metrics._ranking.ndcg_score passes numpydoc validation DOC Ensure that ndcg_score passes numpydoc validation Feb 7, 2022
@thomasjpfan thomasjpfan merged commit e977238 into scikit-learn:main Feb 7, 2022
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Feb 9, 2022
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Mar 1, 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