Skip to content

DOC Ensures that homogeneity_score passes numpydoc validation#23006

Merged
thomasjpfan merged 3 commits intoscikit-learn:mainfrom
aj-white:numpydoc_homogeneity_score
Mar 31, 2022
Merged

DOC Ensures that homogeneity_score passes numpydoc validation#23006
thomasjpfan merged 3 commits intoscikit-learn:mainfrom
aj-white:numpydoc_homogeneity_score

Conversation

@aj-white
Copy link
Copy Markdown
Contributor

@aj-white aj-white commented Mar 31, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

1.Fixes the following test failures in docstring for homogeneity_score

  • 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 "completeness_score" reference
  • SA04: Missing description for See Also "v_measure_score" reference
  1. Remove sklearn.metrics.cluster._supervised.homogeneity_score from DOCSTRING_IGNORE_LIST

Any other comments?

jeremiedbb
jeremiedbb approved these changes Mar 31, 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 @aj-white

@jeremiedbb jeremiedbb added the Quick Review For PRs that are quick to review label Mar 31, 2022
thomasjpfan
thomasjpfan approved these changes Mar 31, 2022
View reviewed changes
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! LGTM

@thomasjpfan thomasjpfan merged commit 4253eac into scikit-learn:main Mar 31, 2022
@aj-white aj-white deleted the numpydoc_homogeneity_score branch April 1, 2022 12:37
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 6, 2022
@aj-white @glemaitre
DOC Ensures that homogeneity_score passes numpydoc validation (scikit…
9c17d0b 
…-learn#23006)
jjerphan pushed a commit to jjerphan/scikit-learn that referenced this pull request Apr 29, 2022
@aj-white @jjerphan
DOC Ensures that homogeneity_score passes numpydoc validation (scikit…
5b6f9b6 
…-learn#23006)
@thomasjpfan thomasjpfan mentioned this pull request May 5, 2022
Closed
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

@jeremiedbb jeremiedbb jeremiedbb approved these changes

Assignees

No one assigned

Labels

Documentation module:metrics No Changelog Needed Quick Review For PRs that are quick to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aj-white @thomasjpfan @jeremiedbb