FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: Fix matching for version switcher by QuLogic · Pull Request #28644 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

DOC: Fix matching for version switcher - #28644

Merged
QuLogic merged 1 commit into
matplotlib:mainfrom
QuLogic:fix-version-match
Aug 2, 2024
ConversationCommits (1)ChecksFiles changed
Merged

DOC: Fix matching for version switcher#28644
QuLogic merged 1 commit into
matplotlib:mainfrom
QuLogic:fix-version-match

Conversation

QuLogic commented Aug 1, 2024

Copy link
Copy Markdown
Member

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

DOC: Fix matching for version switcher
f725652 
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.
github-actions Bot added the Documentation: build building the docs label Aug 1, 2024
timhoffm approved these changes Aug 1, 2024
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for cleaning this up!

story645 commented Aug 2, 2024

Copy link
Copy Markdown
Member

Is it supposed to behave like this on mobile?
https://github.com/user-attachments/assets/61c146c9-9032-4074-960d-38335676017f

QuLogic commented Aug 2, 2024

Copy link
Copy Markdown
Member Author

This PR would only affect devdocs and the next release. I'm not sure what else you're pointing out in the video.

story645 commented Aug 2, 2024

Copy link
Copy Markdown
Member

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.

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

I think I had read this to mean no switcher on those pages, not switcher that I can't change on those pages.

tacaswell reviewed Aug 2, 2024
View reviewed changes
Comment thread doc/conf.py

QuLogic commented Aug 2, 2024

Copy link
Copy Markdown
Member Author

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.

This PR doesn't affect any published pages. They were already broken (as in the linked issue).

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

I think I had read this to mean no switcher on those pages, not switcher that I can't change on those pages.

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.

story645 commented Aug 2, 2024

Copy link
Copy Markdown
Member

No, it means that the switcher won't be set to anything, not that it won't work.

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.

tacaswell commented Aug 2, 2024

Copy link
Copy Markdown
Member

Do we need to go back and fix the matching in older published versions?

tacaswell added this to the v3.9-doc milestone Aug 2, 2024
tacaswell approved these changes Aug 2, 2024
View reviewed changes

tacaswell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Can self merge after sorting out if this should be backported.

QuLogic mentioned this pull request Aug 2, 2024
Closed

QuLogic commented Aug 2, 2024

Copy link
Copy Markdown
Member Author

Do we need to go back and fix the matching in older published versions?

See #28639 (comment)

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.

This seems to only affect 3.8, for some reason, though it's fine on the desktop site.

QuLogic merged commit adb97e8 into matplotlib:main Aug 2, 2024
QuLogic deleted the fix-version-match branch August 2, 2024 05:28
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 2, 2024
Backport PR matplotlib#28644: DOC: Fix matching for version switcher
105533f
meeseeksmachine mentioned this pull request Aug 2, 2024
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 2, 2024
Backport PR matplotlib#28644: DOC: Fix matching for version switcher
ab258b7
meeseeksmachine mentioned this pull request Aug 2, 2024
Merged

QuLogic commented Aug 2, 2024

Copy link
Copy Markdown
Member Author

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.

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

tacaswell added a commit that referenced this pull request Aug 2, 2024
Merge pull request #28645 from meeseeksmachine/auto-backport-of-pr-28…
486e1e2 
…644-on-v3.9.x

Backport PR #28644 on branch v3.9.x (DOC: Fix matching for version switcher)
tacaswell added a commit that referenced this pull request Aug 2, 2024
Merge pull request #28646 from meeseeksmachine/auto-backport-of-pr-28…
0373818 
…644-on-v3.9.1-doc

Backport PR #28644 on branch v3.9.1-doc (DOC: Fix matching for version switcher)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

tacaswell tacaswell approved these changes
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation: build building the docs

Projects

None yet

Milestone

v3.9-doc

Development

Successfully merging this pull request may close these issues.

[Doc]: Version switcher is broken

4 participants

Back | FazBrowse Home | New Git URL