Skip to content

DOC Add missing links to Neighborhood Components Analysis #30849

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.

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

Closed
wants to merge 2 commits into from

Conversation

lc542
Copy link

@lc542 lc542 commented Feb 18, 2025

What does this implement/fix? Explain your changes.

Towards #30621. Linked examples for plot_nca_classification.py, plot_nca_dim_reduction.py, and plot_nca_illustration.py from examples/neighbors.

Copy link

github-actions bot commented Feb 18, 2025

✔️ Linting Passed

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

Generated for commit: a395123. Link to the linter CI: here

@StefanieSenger
Copy link
Contributor

StefanieSenger commented Feb 18, 2025

Hello @lc542,

thank you for your contribution.

As part of triaging it, I looked through the repo and found these examples are already heavily referenced in the user guide: I found references containing plot_nca_ 8 times in neighbors.rst and the references you added in _nca.py are pretty general. We have been discussing cases like these and we have decided that especially in the docstrings, we want to have real usability improvements from added references, since we already have the examples gallery on the bottom of the page.

This is why I think it is best to close your PR, since - through your contribution - we found out that we don't need to further add references to these three examples. Thank you for making the effort and helping us to come to a conclusion about these examples.

For expectation management I have just added this section on the issue description:

Important: We estimate that only 70% of the examples in this list will ultimately be referenced. This means part of the task is deciding which examples deserve being referenced and we are aware that this is not a trivial decision, especially for new contributors. We encourage you to share your reasoning, and a team member will make the final call. We hope this isn’t too frustrating, but please know that evaluating an example is not just an exercise for new contributors; it’s a meaningful and valuable contribution to the project, even (and especially) if the example you worked on doesn’t end up being referenced.

I hadn't been there when you started your PR, so I wanted to draw your attention to it.

Thank you for your effort and your valuable contribution!

Please feel free to pick another example or contribute in a different issue.

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