Skip to content

DOC Ensure homogeneity_completeness_v_measure passes numpydoc validation#23942

Merged
jeremiedbb merged 3 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.cluster._supervised.homogeneity_completeness_v_measure
Jul 19, 2022
Merged

DOC Ensure homogeneity_completeness_v_measure passes numpydoc validation#23942
jeremiedbb merged 3 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.cluster._supervised.homogeneity_completeness_v_measure

Conversation

@Mathews-Tom
Copy link
Copy Markdown
Contributor

@Mathews-Tom Mathews-Tom commented Jul 19, 2022

Reference Issues/PRs
Address #21350

What does this implement/fix? Explain your changes.

  1. Remove sklearn.metrics.cluster._supervised.homogeneity_completeness_v_measure from test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST
  2. Fix the following
    • 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 "."
    • RT04: Return value description should start with a capital letter
    • RT05: Return value 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 "v_measure_score" reference

jeremiedbb
jeremiedbb approved these changes Jul 19, 2022
View reviewed changes
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 1ac8ea1 into scikit-learn:main Jul 19, 2022
@thomasjpfan thomasjpfan mentioned this pull request Jul 19, 2022
Closed
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.cluster._supervised.homogeneity_completeness_v_measure branch July 20, 2022 04:18
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
@Mathews-Tom @glemaitre
DOC Ensure homogeneity_completeness_v_measure passes numpydoc validat…
19acbd4 
…ion (scikit-learn#23942)
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
@Mathews-Tom @glemaitre
DOC Ensure homogeneity_completeness_v_measure passes numpydoc validat…
fd3b055 
…ion (#23942)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeremiedbb jeremiedbb jeremiedbb 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.

2 participants

@Mathews-Tom @jeremiedbb