Skip to content

DOC Add link to plot_swissroll example#31378

Merged
betatim merged 2 commits intoscikit-learn:mainfrom
greygosu:my_feature
May 20, 2025
Merged

DOC Add link to plot_swissroll example#31378
betatim merged 2 commits intoscikit-learn:mainfrom
greygosu:my_feature

Conversation

@greygosu
Copy link
Copy Markdown
Contributor

Reference Issues/PRs
Towards #30621

What does this implement/fix? Explain your changes.
Added a link to the plot_swissroll.py example to mainfold.rst in the User Guide.

@github-actions
Copy link
Copy Markdown

github-actions bot commented May 18, 2025

✔️ Linting Passed

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

Generated for commit: 56867eb. Link to the linter CI: here

@betatim
Copy link
Copy Markdown
Member

betatim commented May 20, 2025

Restarted the docs build - it failed because downloading a dataset failed. Otherwise looks good to me

@betatim betatim enabled auto-merge (squash) May 20, 2025 13:15
@betatim betatim merged commit b1ba38b into scikit-learn:main May 20, 2025
34 checks passed
@StefanieSenger
Copy link
Copy Markdown
Member

Congratulations on your first contribution, @greygosu 🚀 - and thanks for reviewing, @betatim!

For future PRs, just a quick note: the issue description mentions not adding new links to the Examples section. That section was originally intended for plain code examples, and we'd like to avoid reinforcing the practice of including links there. Also, the longer the list gets, the harder it becomes to find anything. It's usually better to find a more fitting spot elsewhere in the documentation.

@betatim
Copy link
Copy Markdown
Member

betatim commented May 21, 2025

Ahrg :-/ I didn't read enough of the original issue to notice :(

The idea is that the example section should only contain literal code examples, not links to other examples/the gallery?

@StefanieSenger
Copy link
Copy Markdown
Member

The idea is that the example section should only contain literal code examples, not links to other examples/the gallery?

Yes, I also only learned that when discussing with the doc team. And we definitely are doing it wrong in many places and the Examples section has gotten a bit messy over time. I am trying to not add to the messiness with this issue whenever I can and do nit picky reviews pretty often. 😅

jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request May 30, 2025
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