Skip to content

DOC Ensure pairwise_distances_argmin_min passes numpydoc validation#23952

Merged
thomasjpfan merged 5 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.pairwise_distances_argmin_min
Jul 19, 2022
Merged

DOC Ensure pairwise_distances_argmin_min passes numpydoc validation#23952
thomasjpfan merged 5 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.pairwise_distances_argmin_min

Conversation

@Mathews-Tom
Copy link
Copy Markdown
Contributor

Reference Issues/PRs
Address #21350

What does this implement/fix? Explain your changes.

  1. Remove sklearn.metrics.pairwise.pairwise_distances_argmin_minfrom test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST.
  2. Fix the following:
    • RT04: Return value description should start with a capital letter
    • SA04: Missing description for See Also "sklearn.metrics.pairwise_distances" reference
    • SA04: Missing description for See Also "sklearn.metrics.pairwise_distances_argmin" reference

- Change return value description to start with capital letter.
- Add description for See Also "pairwise_distances" reference.
- Add description for See Also "pairwise_distances_argmin" reference.
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.

Thanks for the PR @Mathews-Tom. Here are a few suggestions

Mathews-Tom and others added 2 commits July 20, 2022 01:30
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
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 fad3822 into scikit-learn:main Jul 19, 2022
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.pairwise.pairwise_distances_argmin_min branch July 20, 2022 04:18
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
…scikit-learn#23952)

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
…#23952)

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@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.

3 participants