-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
DOC: Fix matching for version switcher #28644
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
Conversation
A released version should point to its version, not 'stable', since that doesn't appear in the version switcher. And devdocs should point to 'dev', since that's what it's called in the JSON.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for cleaning this up!
Is it supposed to behave like this on mobile? |
This PR would only affect devdocs and the next release. I'm not sure what else you're pointing out in the video. |
That everything else is broken in a way that's really confusing UX.
I think I had read this to mean no switcher on those pages, not switcher that I can't change on those pages. |
This PR doesn't affect any published pages. They were already broken (as in the linked issue).
No, it means that the switcher won't be set to anything, not that it won't work. Only the latest micro is listed, so 3.8.4 will show 3.8, but if you go to the 3.8.3 page, the switcher will be unset. However, you can only get to 3.8.3 manually, the switcher would not point you there. |
So should have explained this better, but in those screen caps the switcher doesn't work/drop down, I have to instead click on the docs, which I think is why I end up clicking on the docs link which gets me to the micro. |
Do we need to go back and fix the matching in older published versions? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can self merge after sorting out if this should be backported.
See #28639 (comment)
This seems to only affect 3.8, for some reason, though it's fine on the desktop site. |
Should be fixed by matplotlib/matplotlib.github.com@0f5cb9b |
…644-on-v3.9.x Backport PR #28644 on branch v3.9.x (DOC: Fix matching for version switcher)
…644-on-v3.9.1-doc Backport PR #28644 on branch v3.9.1-doc (DOC: Fix matching for version switcher)
PR summary
A released version should point to its version, not 'stable', since that doesn't appear in the version switcher. And devdocs should point to 'dev', since that's what it's called in the JSON.
Note that in our JSON, we only list up to meso versions, though the version is noted in full. This means that older micro versions will not have an entry in the switcher, and the switcher will not be set to anything if you go there, but that's probably fine.
PR checklist