Skip to content

DOC Ensures that pair_confusion_matrix passes numpydoc validation #24094

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 8 commits into from
Aug 3, 2022
Merged

DOC Ensures that pair_confusion_matrix passes numpydoc validation #24094

merged 8 commits into from
Aug 3, 2022
+10 −11

Conversation

Vincent-Maladiere
Copy link
Contributor

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Fixed the following numpydoc validation error on sklearn.metrics.cluster._supervised.pair_confusion_matrix:

  • GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, References, Examples
  • SA02: Missing period at end of description for See Also "rand_score" reference
  • SA02: Missing period at end of description for See Also "adjusted_rand_score" reference
  • SA02: Missing period at end of description for See Also "adjusted_mutual_info_score" reference

Any other comments?

@Vincent-Maladiere @glemaitre
Update the reference DOI
bb62eea 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Vincent-Maladiere and others added 3 commits August 3, 2022 14:59
@Vincent-Maladiere @glemaitre
Apply suggestions from code review
72e4cf4 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@Vincent-Maladiere
fix DOI index
221b98c
@Vincent-Maladiere
misplaced period
98e662a
@Vincent-Maladiere @glemaitre
Update sklearn/metrics/cluster/_supervised.py
bd48000 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@glemaitre
Copy link
Member

The rendering is fine (just double full-stop and I just removed one).
Merging now. Thanks @Vincent-Maladiere

@glemaitre glemaitre merged commit 076442c into scikit-learn:main Aug 3, 2022
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
@Vincent-Maladiere @glemaitre
DOC Ensures that pair_confusion_matrix passes numpydoc validation (s…
b26dbd8 
…cikit-learn#24094)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit that referenced this pull request Aug 5, 2022
@Vincent-Maladiere @glemaitre
DOC Ensures that pair_confusion_matrix passes numpydoc validation (#…
4ad7b04 
…24094)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@thomasjpfan thomasjpfan mentioned this pull request Aug 12, 2022
Closed
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Sep 12, 2022
@Vincent-Maladiere @glemaitre
DOC Ensures that pair_confusion_matrix passes numpydoc validation (s…
544cb6c 
…cikit-learn#24094)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre glemaitre left review comments

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
@Vincent-Maladiere @glemaitre