8000 DOC: update "Previous Whats New" for 2.2 with reference to cividis paper by adeak · Pull Request #12184 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

DOC: update "Previous Whats New" for 2.2 with reference to cividis paper #12184

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 20, 2018

Conversation

adeak
Copy link
Contributor
@adeak adeak commented Sep 20, 2018

Update the "Previously Whats New" for 2.2 with a reference to the now-published paper discussing cividis. I kept most of the original text (but added an accent to the name of the first author) and turned it into one long inline link pointing to the DOI of the paper published in PLoS ONE.

Same change as #12179 (that one for 2.2.3 backport, this one for master).

@jklymak
Copy link
Member
jklymak commented Sep 20, 2018

Do we usually update the What’s New log? This info would be great where the cividis colormap is discussed in the main docs.

@adeak
Copy link
Contributor Author
adeak commented Sep 20, 2018

@jklymak I'm unsure, honestly. For what it's worth there are recent backport commits to the What's New of the 2.2.3 branch, and it would make sense to keep the two on par.

It seems that the current colormap page discusses very little (if anything) about the perceptually uniform colormaps, so I figured I should intrude as little as possible with the citation update. That being said I'd certainly support adding a few paragraphs about viridis and friends and cividis and now twilight to that page, where anyone would be looking for them. Or (since this has become a bit of a flagship feature in my eyes) add a new page detailing the color vision problem and the attempted solutions.

Whenever I currently try to convince someone to use perceptually uniform colormaps I point them to the SciPy 2015 video. If there's a comparably instructive description on matplotlib.org I haven't found it yet.

@jklymak
Copy link
Member
jklymak commented Sep 20, 2018

The Choosing colormaps tutorial doesn’t cover that?

@adeak
Copy link
Contributor Author
adeak commented Sep 20, 2018

I guess there are plenty of links to material on color blindness, and a brief paragraph explaining the concept of perceptual uniformity. I guess I just miss a more hands-on explanation, similar to the comparisons in the scipy 2015 video or the cividis paper.

Anyway, just to bring myself back on topic a bit, I guess there would be room to add a few words about cividis to the tutorial page.

@jklymak
Copy link
Member
jklymak commented Sep 20, 2018

Sounds reasonable to me. I think that tutorial predated cividis so a section extolling it’s virtues or the advantage of perceptually uniform colormaps in general would be welcome.

@tacaswell tacaswell added this to the v2.2-doc milestone Sep 20, 2018
@tacaswell tacaswell merged commit b248b58 into matplotlib:master Sep 20, 2018
@lumberbot-app
Copy link
lumberbot-app bot commented Sep 20, 2018

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v2.2.3-doc
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 b248b58a4676438e27d39a91ad136422f52ef40c
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #12184: DOC: update "Previous Whats New" for 2.2 with reference to cividis paper'
  1. Push to a named branch :
git push YOURFORK v2.2.3-doc:auto-backport-of-pr-12184-on-v2.2.3-doc
  1. Create a PR against branch v2.2.3-doc, I would have named this PR:

"Backport PR #12184 on branch v2.2.3-doc"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

@adeak
Copy link
Contributor Author
adeak commented Sep 20, 2018

@tacaswell thanks for the merge. Quick question: should I close #12179 and instead do what MeeSeeks told me to do to keep the history as standard as possible?

@tacaswell
Copy link
Member

Lets leave #12179 open and ignore meeseeks here.

Backports on moved documentation is never going to go smoothly....

@adeak adeak deleted the doc_cividis_ref_master branch September 20, 2018 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0