Skip to content

DOC Ensure pairwise_distances_argmin passes numpydoc validation#23951

Merged
jeremiedbb merged 4 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.pairwise_distances_argmin
Jul 19, 2022
Merged

DOC Ensure pairwise_distances_argmin passes numpydoc validation#23951
jeremiedbb merged 4 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.pairwise_distances_argmin

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_argminfrom test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST.
  2. Fix the following:
    • SA04: Missing description for See Also "pairwise_distances" reference
    • SA04: Missing description for See Also "pairwise_distances_argmin_min" reference

- Add description for See Also "pairwise_distances" reference.
- Add description for See Also "pairwise_distances_argmin_min" 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 19, 2022 17:51
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

@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.

LGTM. Thanks @Mathews-Tom

@jeremiedbb jeremiedbb merged commit a81ba1d into scikit-learn:main Jul 19, 2022
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.pairwise.pairwise_distances_argmin branch July 19, 2022 19:44
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
…ikit-learn#23951)

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

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