Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Add reference to valid metrics for KDTree and BallTree #32717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 17, 2025
Merged

DOC Add reference to valid metrics for KDTree and BallTree #32717

merged 2 commits into from
Nov 17, 2025
+4 −2

Conversation

@virchan
Copy link
Member

@virchan virchan commented Nov 15, 2025 •
edited
Loading

Reference Issues/PRs

Fixes #32686

What does this implement/fix? Explain your changes.

This PR adds a reference to the metric parameter in the KDTree and BallTree documentation, linking it to the valid_metrics listed in the user guide.

Any other comments?

Although CI doesn't display the updated documentation from the Cython files, a Google search suggests that this PR only affects the KDTree and BallTree documentation.

@github-actions
Copy link

github-actions bot commented Nov 15, 2025

✔️ Linting Passed

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

Generated for commit: 6aa2b98. Link to the linter CI: here

@virchan virchan marked this pull request as ready for review November 15, 2025 10:45
@virchan virchan added the good first PR to review Simple atomic PR to review label Nov 15, 2025
@virchan
Copy link
Member Author

virchan commented Nov 15, 2025

@AnneBeyer, would you like to have a look?

lucyleeow
lucyleeow approved these changes Nov 17, 2025
View reviewed changes
Copy link
Member

@lucyleeow lucyleeow left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM!

Can confirm the API docs look fine:
https://output.circle-artifacts.com/output/job/d5655acf-cb39-4a68-bed7-4f88a5d8012a/artifacts/0/doc/modules/generated/sklearn.neighbors.KDTree.html#sklearn.neighbors.KDTree
and
https://output.circle-artifacts.com/output/job/d5655acf-cb39-4a68-bed7-4f88a5d8012a/artifacts/0/doc/modules/generated/sklearn.neighbors.BallTree.html#sklearn.neighbors.BallTree

('check rendered docs' CI will only show you have quick links to doc files that have be changed, and in this case it doesn't pick up on the API docs, but I think all docs (maybe not all examples, only changed ones) are still rendered and you can click through to them)

AnneBeyer
AnneBeyer approved these changes Nov 17, 2025
View reviewed changes
Copy link
Contributor

@AnneBeyer AnneBeyer left a comment

Choose a reason for hiding this comment

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

LGTM! Nice and simple. Thanks!

@lucyleeow lucyleeow merged commit 0cd2b7e into scikit-learn:main Nov 17, 2025
43 checks passed
@lucyleeow
Copy link
Member

lucyleeow commented Nov 17, 2025

Thanks all, merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lucyleeow lucyleeow lucyleeow approved these changes

+1 more reviewer

@AnneBeyer AnneBeyer AnneBeyer approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cython Documentation good first PR to review Simple atomic PR to review module:neighbors

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Clarify docs for allowable KDTree metrics

3 participants

@virchan @lucyleeow @AnneBeyer