Skip to content

[MRG] DOC Add docstring DistanceMetric class#26795

Merged
glemaitre merged 9 commits intoscikit-learn:mainfrom
greyisbetter:distancemetric-docs
Jul 24, 2023
Merged

[MRG] DOC Add docstring DistanceMetric class#26795
glemaitre merged 9 commits intoscikit-learn:mainfrom
greyisbetter:distancemetric-docs

Conversation

@greyisbetter
Copy link
Copy Markdown
Contributor

@greyisbetter greyisbetter commented Jul 7, 2023

Towards #26776

Add documentation for the public class DistanceMetric.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 7, 2023

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 89843a0. Link to the linter CI: here

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.

Since we are in a Cython file, I don't think we have a linter to avoid having more than 88 characters.

Could you ensure not to have more than 88 characters for all changes?

@greyisbetter
Copy link
Copy Markdown
Contributor Author

Thanks @glemaitre for the review. I updated each line to under 88 characters and the rest of the suggestions as well.

@greyisbetter greyisbetter requested a review from glemaitre July 13, 2023 09:07
Copy link
Copy Markdown
Contributor

@OmarManzoor OmarManzoor left a comment

Choose a reason for hiding this comment

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

LGTM!

@greyisbetter greyisbetter changed the title DOC Add docstring DistanceMetric class [MRG] DOC Add docstring DistanceMetric class Jul 17, 2023
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.

The rendering looks good. Merging.
Thanks @greyisbetter

@glemaitre glemaitre merged commit ca51d77 into scikit-learn:main Jul 24, 2023
@greyisbetter greyisbetter deleted the distancemetric-docs branch July 24, 2023 09:36
punndcoder28 pushed a commit to punndcoder28/scikit-learn that referenced this pull request Jul 29, 2023
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 18, 2023
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
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