Skip to content

DOC Ensures that pair_confusion_matrix passes numpydoc validation#24094

Merged
glemaitre merged 8 commits intoscikit-learn:mainfrom
Vincent-Maladiere:fix_doc_pair_confusion_matrix
Aug 3, 2022
Merged

DOC Ensures that pair_confusion_matrix passes numpydoc validation#24094
glemaitre merged 8 commits intoscikit-learn:mainfrom
Vincent-Maladiere:fix_doc_pair_confusion_matrix

Conversation

@Vincent-Maladiere
Copy link
Copy Markdown
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?

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Vincent-Maladiere and others added 3 commits August 3, 2022 14:59
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@glemaitre
Copy link
Copy Markdown
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
…cikit-learn#24094)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit that referenced this pull request Aug 5, 2022
…24094)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Sep 12, 2022
…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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants