Skip to content

More figure-related doc updates#10666

Merged
dstansby merged 1 commit into
matplotlib:masterfrom
timhoffm:doc-figure-part-2
Mar 5, 2018
Merged

More figure-related doc updates#10666
dstansby merged 1 commit into
matplotlib:masterfrom
timhoffm:doc-figure-part-2

Conversation

@timhoffm

@timhoffm timhoffm commented Mar 4, 2018

Copy link
Copy Markdown
Member

PR Summary

Docstring updates.

@dstansby dstansby added this to the v2.2.1 milestone Mar 5, 2018
@dstansby dstansby merged commit 5df8380 into matplotlib:master Mar 5, 2018
@lumberbot-app

lumberbot-app Bot commented Mar 5, 2018

Copy link
Copy Markdown

There seem to be a conflict, please backport manually

@timhoffm

timhoffm commented Mar 5, 2018

Copy link
Copy Markdown
Member Author

Is there a description somewhere how to do a manual backport?

@dstansby

dstansby commented Mar 6, 2018

Copy link
Copy Markdown
Member

timhoffm pushed a commit that referenced this pull request Mar 18, 2018
@timhoffm

Copy link
Copy Markdown
Member Author

Manually backported to v2.2.2-doc
68beb9a

@timhoffm timhoffm deleted the doc-figure-part-2 branch March 18, 2018 00:38
@QuLogic

QuLogic commented Mar 18, 2018

Copy link
Copy Markdown
Member

For the future, the -doc branch is only for .rst file changes.

@QuLogic QuLogic modified the milestones: v2.2.1, v2.2-doc Mar 18, 2018
@timhoffm

Copy link
Copy Markdown
Member Author

Ok, should I backport it to 2.2.x as well or is it tolerable as it is now this one time?

@QuLogic

QuLogic commented Mar 18, 2018

Copy link
Copy Markdown
Member

v2.2.2-doc will be merged into v2.2.x, so there's no need to do any more cherry-picking.

@tacaswell tacaswell modified the milestones: v2.2-doc, v3.0 Mar 18, 2018
@tacaswell

Copy link
Copy Markdown
Member

This should not have been backported to -doc, I am going to revert that commit.

To build the published docs you install the stable version and then build the docs from the -doc branch so these changes will not reflected in the built docs (see https://matplotlib.org//devel/release_guide.html#build-and-deploy-documentation).

Sorry for not being clearer about this.

Given the discussion at #10822 I am not sure if we want to be backporting docstring changes to 2.2.x.

tacaswell added a commit that referenced this pull request Mar 18, 2018
This reverts commit 68beb9a.

Changes to lib should not be backported to the -doc branch
@tacaswell

Copy link
Copy Markdown
Member

Reverted in a8ac10d

@timhoffm

Copy link
Copy Markdown
Member Author

Since the 2.2.x release will probably be the last one for Python 2, it will be around for some time, even after 3.0 is out. I would welcome backporting docstring improvements there.

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.

4 participants