Skip to content

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

Merged
merged 1 commit into from
Sep 29, 2021
Merged

DOC: Update Matplotlib Colormaps documentation link in chart visualization #43624 #43633

merged 1 commit into from
Sep 29, 2021

Conversation

ricardobohadana
Copy link
Contributor

@ricardobohadana ricardobohadana commented Sep 18, 2021

Fixes: Fixed a chart visualization coiormap section link that linked to an outdated version of matplotlib. Now links to a stable version.

@ricardobohadana ricardobohadana changed the title DOC: Update Matplotlib Colormaps documentation link in chart visualisation #43624 DOC: Update Matplotlib Colormaps documentation link in chart visualization #43624 Sep 18, 2021
@mzeitlin11 mzeitlin11 added this to the 1.4 milestone Sep 18, 2021
Copy link
Member

@mzeitlin11 mzeitlin11 left a comment

Choose a reason for hiding this comment

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

Thanks @ricardobohadana, LGTM!

@mwaskom
Copy link
Contributor

mwaskom commented Sep 18, 2021

Rather than hardcoding the url, why not use an intersphinx reference here?

@ricardobohadana
Copy link
Contributor Author

ricardobohadana commented Sep 18, 2021

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?

@mwaskom
Copy link
Contributor

mwaskom commented Sep 18, 2021

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

@ricardobohadana
Copy link
Contributor Author

ricardobohadana commented Sep 19, 2021

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.

@mwaskom
Copy link
Contributor

mwaskom commented Sep 19, 2021

@ricardobohadana
Copy link
Contributor Author

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?

@mwaskom
Copy link
Contributor

mwaskom commented Sep 20, 2021

Where can I find the label they use for that section?

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:

.. _sphx_glr_gallery_color_colormap_reference.py:

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?

(I am not a pandas maintainer and have no opinion on the best path forward, just dropping by with a suggestion).

@mzeitlin11
Copy link
Member

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

@attack68
Copy link
Contributor

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?

agreed, I would just merge as is and open an issue for intersphinx, Perhaps it could be part of a beginners sprint or soemthing.

@jreback jreback merged commit 37f0363 into pandas-dev:master Sep 29, 2021
@jreback
Copy link
Contributor

jreback commented Sep 29, 2021

thanks @ricardobohadana

@stelios-c
Copy link

Thank you!

@ricardobohadana ricardobohadana deleted the update-matplotlib-colormap-link branch September 29, 2021 21:18
gasparitiago pushed a commit to gasparitiago/pandas that referenced this pull request Oct 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Chart visualisation, Colormaps links to old Matplotlib documentation
6 participants