Skip to content

DOC Ensures that adjusted_mutual_info_score passes numpydoc validation#24344

Merged
glemaitre merged 4 commits intoscikit-learn:mainfrom
Safikh:numpydoc_adjusted_mutual_inf
Sep 4, 2022
Merged

DOC Ensures that adjusted_mutual_info_score passes numpydoc validation#24344
glemaitre merged 4 commits intoscikit-learn:mainfrom
Safikh:numpydoc_adjusted_mutual_inf

Conversation

@Safikh
Copy link
Copy Markdown
Contributor

@Safikh Safikh commented Sep 3, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Edit Docstring of adjusted_mutual_info_score and remove it from the FUNCTION_DOCSTRING_IGNORE_LIST.

Any other comments?

@Safikh Safikh marked this pull request as draft September 3, 2022 05:20
@Safikh Safikh marked this pull request as ready for review September 3, 2022 05:29
@glemaitre
Copy link
Copy Markdown
Member

The CI was failing because the order of the section the docstring is not the right one:

GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, References, Examples

@Safikh
Copy link
Copy Markdown
Contributor Author

Safikh commented Sep 3, 2022

@glemaitre fixed the docstring

@glemaitre glemaitre merged commit 939ce4d into scikit-learn:main Sep 4, 2022
@glemaitre
Copy link
Copy Markdown
Member

Thanks @Safikh Merging.

@Safikh Safikh deleted the numpydoc_adjusted_mutual_inf branch September 4, 2022 07:53
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Sep 12, 2022
scikit-learn#24344)

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