Skip to content

[Doc]: new color documentation should go into user docs #30071

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

Open
jklymak opened this issue May 18, 2025 · 6 comments
Open

[Doc]: new color documentation should go into user docs #30071

jklymak opened this issue May 18, 2025 · 6 comments

Comments

@jklymak
Copy link
Member

jklymak commented May 18, 2025

https://matplotlib.org/stable/gallery/color/color_sequences.html#sphx-glr-gallery-color-color-sequences-py should probably be added/moved to https://matplotlib.org/stable/users/explain/colors/index.html

@jklymak
Copy link
Member Author

jklymak commented May 18, 2025

Should be a follow up to documentation changes in #30065

@story645
Copy link
Member

I think this either overlaps or is a dupe of #28750

@rcomer
Copy link
Member

rcomer commented May 18, 2025

Over the years I have made a lot of use of the other color reference examples List of named colors and Colormaps reference. So I added Color Sequences as an example to fit with those.

Edit: I also recently find myself making a lot of use of the reference tag to find All The Options for a Thing.

@jklymak
Copy link
Member Author

jklymak commented May 18, 2025

Over the years I have made a lot of use of the other color reference examples...

Sure - those examples should probably also be moved/copied. The color docs that are in https://matplotlib.org/stable/users/explain/colors/index.html are just a dumb transfer of what used to be in a "colors" section of the tutorials. Ideally these reference materials would also move/be duplicated in the Users guide. It would be nice, however, if the User guide was actually comprehensive, and documenting core features was done there rather than slipped into the Gallery somewhere.

I also recently find myself making a lot of use of the reference tag to find All The Options for a Thing.

Indices are useful! Not sure if the tagging mechanism can work outside the Gallery, but if it could that would be great.

BTW, I put this in as an issue not to overlap with #30065, but will actually make a PR when that is finished.

@rcomer
Copy link
Member

rcomer commented May 18, 2025

I think everything in the Colormaps reference example is already duplicated in the Choosing colormaps part of the User Guide. However, because the User Guide page has all the discussion, you have to do a fair bit of scrolling if you really just want to see which string gives you which colours.

@story645
Copy link
Member

Indices are useful! Not sure if the tagging mechanism can work outside the Gallery, but if it could that would be great.

Piloted it on gallery to keep scope limited, but it should work on any page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants