Skip to content

adding links to color examples and tutorials in the api page #9544

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 2 commits into from
Oct 23, 2017

Conversation

choldgraf
Copy link
Contributor

per @anntzer 's suggestion, this adds links on the colors API page to the gallery and tutorial section.

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

Per @efiring and @anntzer's suggestions, this may also be a good place to drop in the mention of colorblind friendly maps. @anntzer had good wording for this on the other PR.

@choldgraf
Copy link
Contributor Author

I'm +1 on colorblind-friendly cmap documentation, though wanna keep the scope of this PR relatively narrow since I don't have a ton of time to iterate on this :-) if you give me text that is guaranteed to get approved quickly then I'll add it to this PR, else let's leave it for another PR...that work?

Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

the link doesn't work (and causes linkchecker to fail). see https://github.com/matplotlib/matplotlib/pull/9532/files#diff-577656b3176ed2aa2443bf660405d7b6R11 for the correct syntax.

@choldgraf
Copy link
Contributor Author

@anntzer thanks for the check...latest push uses :ref:. I wasn't sure if :doc: would work since I'm not linking to a specific example, but instead to a subsection of a page.

@anntzer
Copy link
Contributor

anntzer commented Oct 23, 2017

Ah yes (but as a general rule & side note, there's a bunch of

:ref:`sphx_glr_tutorials_foo.py`

which could advantageously be replaced by :doc:/tutorials/foo.)
Feel free to dismiss my review once build passes.

@choldgraf
Copy link
Contributor Author

I definitely don't think to do that often enough - I agree that's a better way to do it

looks like the links work now:

https://2926-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/colors_api.html

@story645
Copy link
Member

@anntzer 's wording is ""for an in-depth overview of colomaps, including discussion about colorblind-friendliness, see (tutorial)".

@choldgraf
Copy link
Contributor Author

ah I see - I thought you meant to actually add in a discussion of colorblind friendliness in this page.

I'm happy to add this in, though TBH we have a pretty scarce treatment of color blindness in the tutorial. E.g. this is the only section I see:

http://matplotlib.org/tutorials/colors/colormaps.html#color-vision-deficiencies

I would be a big +1 on a doc addition that added a more complete treatment for (and list of) colorblind-friendly colormaps.

@NelleV NelleV merged commit c280700 into matplotlib:master Oct 23, 2017
@NelleV
Copy link
Member

NelleV commented Oct 23, 2017

Thanks @choldgraf

@story645
Copy link
Member

@choldgraf totally agree with you that it should probably be a doc addition and would also be +1 for a more complete treatment and list of colorblind friendly maps and pallets (for line/scatter/etc type plots).

@QuLogic QuLogic added this to the v2.2.0 milestone Aug 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants