-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
DOC: Update Matplotlib Colormaps documentation link in chart visualization #43624 #43633
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
DOC: Update Matplotlib Colormaps documentation link in chart visualization #43624 #43633
Conversation
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 @ricardobohadana, LGTM!
Rather than hardcoding the url, why not use an intersphinx reference here? |
I don't know what intersphinx is, could you elaborate a little bit more? |
https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html you can reference the label they use for that section so it will still resolve properly if they reorganize their site in the future |
I've done some research and in order to use intersphinx, both docs must use intersphinx as extension to their documentation and I don't know if either pandas or matplotlib use it. |
Where can I find the label they use for that section? And wouldn't it be more useful to create a new issue to change all the documentation to use intersphinx, rather than a single link/element? |
If you click "show page source" on the matplotlib docs (and most sphinx sites) you can see the raw rst. Right above the H1 element there's a reference target:
(I am not a pandas maintainer and have no opinion on the best path forward, just dropping by with a suggestion). |
I'd be happy merging this as is since a definite improvement, but will wait a bit to see if others weigh in. Thanks for the idea @mwaskom - if you wouldn't mind opening an issue with the suggestion of using more intersphinx (and the related advantages), that would be awesome |
agreed, I would just merge as is and open an issue for intersphinx, Perhaps it could be part of a beginners sprint or soemthing. |
thanks @ricardobohadana |
Thank you! |
Fixes: Fixed a chart visualization coiormap section link that linked to an outdated version of matplotlib. Now links to a stable version.