Skip to content

DOC: update "What's new" with reference to cividis paper #12179

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
Oct 3, 2018

Conversation

adeak
Copy link
Contributor

@adeak adeak commented Sep 20, 2018

Update the "What's new" for 2.2.3 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. The patched version compiles with sphinx.

@adeak
Copy link
Contributor Author

adeak commented Sep 20, 2018

I should probably add that the CircleCI builds are failing with an error that I saw myself when building, and when I said the patch compiles with sphinx I meant with the -W switch omitted. Considering how the same warnings are present in the original v2.2.3-doc branch I suspect the source of the test failures is not in my changes.

@ImportanceOfBeingErnest
Copy link
Member

For this one I don't know what the best route of action is. I guess it makes sense to have it in the "what's new in 2.2.3" of the 2.2.3 docs, but of course in the "Previous what's new" of any subsequent release as well. Would that require two different PRs to be created, one against master and one against the 2.2.3 branch?

@adeak
Copy link
Contributor Author

adeak commented Sep 20, 2018

Aren't the "Previously what's new" items just links to the generated what's news of earlier version? Is there a "What's new in 2.2.3" other than this one?

@adeak
Copy link
Contributor Author

adeak commented Sep 20, 2018

Nevermind, you're right of course, found it. Since 2.2.3 is LTS for python 2 users we should edit both I believe.

@adeak
Copy link
Contributor Author

adeak commented Sep 20, 2018

Submitted #12184 for master because it's easier to ask for forgiveness.

@tacaswell tacaswell added this to the v2.2-doc milestone Sep 20, 2018
@tacaswell
Copy link
Member

The circle failures are understood, we have to backport a bunch of commits to this branch to cope with the sphinx 1.8 changes.

@dstansby
Copy link
Member

dstansby commented Oct 1, 2018

@adeak the failures should be sorted now, would you be able to rebase this on to the current master branch?

@adeak
Copy link
Contributor Author

adeak commented Oct 1, 2018

@dstansby I'm afraid I'm confused. Master should correspond to 3.0, so its doc/users/whats_new.rst is incompatible with the 2.2 What's New that I'm trying to fix in this backport. But the v2.2.3-doc branch where I thought this would belong hasn't seen a new commit since I opened this PR. What am I missing?

@ImportanceOfBeingErnest
Copy link
Member

I would have though it's enough to rerun the tests. I tried to trigger this by closing and reopening, but it won't work the circleci tests.

@adeak adeak force-pushed the doc_cividis_ref_patch branch from 99037f4 to 869a1c6 Compare October 1, 2018 22:34
@adeak
Copy link
Contributor Author

adeak commented Oct 1, 2018

@ImportanceOfBeingErnest I touched the PR with a no-op commit amend; this seems to have triggered all the tests.

@adeak
Copy link
Contributor Author

adeak commented Oct 1, 2018

No luck; though I'm not terribly surprised considering that the code base hasn't changed since I opened the PR. After Ernest's comment I was hoping there was some configuration change or something in the background that could have fixed the issue regardless.

@ImportanceOfBeingErnest
Copy link
Member

Ha, it's even worse, now travis fails as well for some unrelated reason. I think one has to wait until this gets fixed - those tests are beyond my paygrade.

@QuLogic
Copy link
Member

QuLogic commented Oct 2, 2018

I would have though it's enough to rerun the tests. I tried to trigger this by closing and reopening, but it won't work the circleci tests.

Unfortunately, CircleCI builds the head of the PR, not the merge of the PR and the target, like the other CIs do. That being said, there were no backports to the v2.2.3-doc branch, so it's unlikely for anything to work anyway.

@QuLogic
Copy link
Member

QuLogic commented Oct 2, 2018

This should work now if rebased, for doc builds only. Travis fixes are still in progress.

@adeak adeak force-pushed the doc_cividis_ref_patch branch from 869a1c6 to 404b093 Compare October 2, 2018 09:41
@adeak
Copy link
Contributor Author

adeak commented Oct 2, 2018

Thank you, all, indeed Circle works now and Travis breaks still.

Copy link
Member

@timhoffm timhoffm 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 works correctly: https://14327-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/users/whats_new.html

and as far as I understand, it's correct to directly merge this into v2.2.3-doc (see #12184 (comment)).

The Travis failure is fixed by #12366. Since this PR is trivial, I wouldn't insist on rebasing before merging.

@QuLogic
Copy link
Member

QuLogic commented Oct 3, 2018

Well, that fix has not come back to this branch anyway.

@QuLogic QuLogic merged commit e2ee53b into matplotlib:v2.2.3-doc Oct 3, 2018
@adeak adeak deleted the doc_cividis_ref_patch branch October 3, 2018 19:09
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.

6 participants