Skip to content

DOC Ensure cosine_distances passes numpydoc validation#23946

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

DOC Ensure cosine_distances passes numpydoc validation#23946
jeremiedbb merged 2 commits intoscikit-learn:mainfrom
Mathews-Tom:Issue_21350-sklearn.metrics.pairwise.cosine_distances

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.cosine_distancesfrom test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST.
  2. Fix the following:
    • RT03: Return value has no description
    • SA04: Missing description for See Also "cosine_similarity" reference

- Add description for return value.
- Add description for See Also "cosine_similarity" 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.

LGTM. Thanks @Mathews-Tom

@jeremiedbb jeremiedbb merged commit b547953 into scikit-learn:main Jul 19, 2022
@Mathews-Tom Mathews-Tom deleted the Issue_21350-sklearn.metrics.pairwise.cosine_distances branch July 19, 2022 12:52
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
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