Skip to content

DOC add metadata_routing.rst to User Guide sidebar #31184

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

Merged

Conversation

StefanieSenger
Copy link
Contributor

Reference Issues/PRs

closes #30964

What does this implement/fix? Explain your changes.

Adds metadata_routing.rst to User Guide sidebar

Copy link

✔️ Linting Passed

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

Generated for commit: 96fe267. Link to the linter CI: here

@StefanieSenger
Copy link
Contributor Author

StefanieSenger commented Apr 11, 2025

I also did some research on including sub-headings in the sidebar too, as in some of the other parts of the user guide. Here is what I found out:

  • sub headings will not show up the the left sidebar, unless the file is split up into these separate parts (and then we would use toctree for defining the sections
    • disadvantages include: users need extra click(s) to read through; sections 4.2 and 4.3 are a bit short; odd version history (also with git cp and then removing the rest)
  • sub-headings of single files will however automatically show in the right sidebar in the "On this page" menue

Therefore, I would keep the file as one, as it is.

@virchan virchan added the Metadata Routing all issues related to metadata routing, slep006, sample props label Apr 12, 2025
Copy link
Member

@lorentzenchr lorentzenchr left a comment

Choose a reason for hiding this comment

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

@StefanieSenger Thanks for addressing this.

@lorentzenchr lorentzenchr added Quick Review For PRs that are quick to review Waiting for Second Reviewer First reviewer is done, need a second one! labels Apr 15, 2025
Copy link
Member

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

Thanks!

@lucyleeow lucyleeow merged commit 5059058 into scikit-learn:main Apr 17, 2025
51 checks passed
@StefanieSenger StefanieSenger deleted the doc_visibility_metadata_routing branch April 17, 2025 08:03
lucyleeow pushed a commit to EmilyXinyi/scikit-learn that referenced this pull request Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Metadata Routing all issues related to metadata routing, slep006, sample props Quick Review For PRs that are quick to review Waiting for Second Reviewer First reviewer is done, need a second one!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC better visibility in navigation of metadata routing
4 participants