Skip to content

DOC Ensures that rand_score passes numpydoc validation#24096

Merged
jjerphan merged 10 commits intoscikit-learn:mainfrom
Vincent-Maladiere:fix_doc_rand_score
Aug 9, 2022
Merged

DOC Ensures that rand_score passes numpydoc validation#24096
jjerphan merged 10 commits intoscikit-learn:mainfrom
Vincent-Maladiere:fix_doc_rand_score

Conversation

@Vincent-Maladiere
Copy link
Copy Markdown
Contributor

@Vincent-Maladiere Vincent-Maladiere commented Aug 3, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Fixed the following errors on sklearn.metrics.cluster._supervised.rand_score:

  • 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 "adjusted_rand_score" reference
  • SA02: Missing period at end of description for See Also "adjusted_mutual_info_score" reference

Any other comments?

glemaitre
glemaitre reviewed Aug 3, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can improve the linking and replace with use the DOI directive for the article.

Vincent-Maladiere and others added 4 commits August 3, 2022 14:14
@Vincent-Maladiere @glemaitre
DOI suggestion #1
5d29800 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@Vincent-Maladiere @glemaitre
DOI update suggestion scikit-learn#2
8091ea4 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@Vincent-Maladiere @glemaitre
DOI update suggestion
169555b 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@Vincent-Maladiere
fix reference index so that we can see them in the doc
787ac8d
glemaitre
glemaitre reviewed Aug 3, 2022
View reviewed changes
jjerphan
jjerphan approved these changes Aug 8, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@jjerphan jjerphan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just one remark.

jjerphan
jjerphan reviewed Aug 9, 2022
View reviewed changes
@Vincent-Maladiere @jjerphan
Update sklearn/tests/test_docstrings.py
4298bbe 
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
@jjerphan jjerphan merged commit f0cbdc1 into scikit-learn:main Aug 9, 2022
@thomasjpfan thomasjpfan mentioned this pull request Aug 12, 2022
Closed
@ArturoAmorQ ArturoAmorQ mentioned this pull request Sep 6, 2022
Closed
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Sep 12, 2022
@Vincent-Maladiere @glemaitre @jjerphan
DOC Ensures that rand_score passes numpydoc validation (scikit-lear…
c3b3df8 
…n#24096)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
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

@jjerphan jjerphan jjerphan 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 @glemaitre @jjerphan