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

Skip to content

DOC Ensures v_measure_score passes numpydoc validation #24097

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 4, 2022
Merged

DOC Ensures v_measure_score passes numpydoc validation #24097

merged 2 commits into from
Aug 4, 2022

Conversation

Vincent-Maladiere
Copy link
Contributor

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Fixed the following errors on sklearn.metrics.cluster._supervised.v_measure_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
  • GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, References, Examples
  • PR08: Parameter "labels_true" description should start with a capital letter
  • PR09: Parameter "labels_true" description should finish with "."
  • PR08: Parameter "labels_pred" description should start with a capital letter
  • PR09: Parameter "labels_pred" description should finish with "."
  • RT04: Return value description should start with a capital letter
  • RT05: Return value description should finish with "."
  • SA04: Missing description for See Also "homogeneity_score" reference
  • SA04: Missing description for See Also "completeness_score" reference
  • SA04: Missing description for See Also "normalized_mutual_info_score" reference

Any other comments?

@Vincent-Maladiere Vincent-Maladiere changed the title Fix doc validation error for v_measure_score DOC Ensures v_measure_score passes numpydoc validation Aug 4, 2022
thomasjpfan
thomasjpfan approved these changes Aug 4, 2022
View reviewed changes
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! LGTM

@thomasjpfan thomasjpfan merged commit b3fe9b8 into scikit-learn:main Aug 4, 2022
@thomasjpfan thomasjpfan mentioned this pull request Aug 12, 2022
Closed
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 12, 2022
@Vincent-Maladiere @glemaitre
DOC Ensures v_measure_score passes numpydoc validation (scikit-lear…
57c9046 
…n#24097)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

Assignees
No one assigned
Labels
Documentation module:metrics No Changelog Needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Vincent-Maladiere @thomasjpfan @jjerphan