Skip to content
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

Document mpl_toolkits.axes_grid1.anchored_artists #4874

Merged
merged 9 commits into from Dec 26, 2015

Conversation

sargas
Copy link
Contributor

@sargas sargas commented Aug 6, 2015

Here's another PR following up on #4864.

The documentation isn't built with this commit, but I'll
push another commit (or open another PR if this is already merged) to add the API docs
to doc/mpl_toolkits/axes_grid/api/index.rst once PR #4864 is merged.

@tacaswell tacaswell added this to the next major release (2.0) milestone Oct 8, 2015
@@ -1,43 +1,152 @@
from __future__ import (absolute_import, division, print_function,
unicode_literals)

from matplotlib.externals import six
Copy link
Member

Choose a reason for hiding this comment

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

please leave the six import even if it isn't used to keep our files consistent.

@mdboom
Copy link
Member

mdboom commented Dec 14, 2015

I think this is ready to merge once you address @tacaswell's minor comment.

@sargas
Copy link
Contributor Author

sargas commented Dec 16, 2015

@mdboom sure, but could we hold off until #4864 is merged? It adds a axes_grid1 section to doc/mpl_toolkits/axes_grid/api/index.rst that would be useful to also change in this PR.

@tacaswell
Copy link
Member

merged #4864 cycled open/close to re-trigger travis on new master

@sargas
Copy link
Contributor Author

sargas commented Dec 17, 2015

I've rebased, readded the six import, and enabled the docs to be built in the latest commits.

I did have to change one of the examples which imported matplolib.offsetbox.AnchoredText from mpl_toolkits.axes_grid1.anchored_artists, where it was removed as an unused import. I don't know how API-breaking this is if anyone copied that example.


if __name__ == "__main__":

import matplotlib.pyplot as plt
Copy link
Member

Choose a reason for hiding this comment

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

Is it worth moving this code to an example?

jenshnielsen added a commit that referenced this pull request Dec 26, 2015
Document mpl_toolkits.axes_grid1.anchored_artists
@jenshnielsen jenshnielsen merged commit b6a79ac into matplotlib:master Dec 26, 2015
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull request Oct 16, 2016
Document mpl_toolkits.axes_grid1.anchored_artists

Conflicts:
	lib/mpl_toolkits/axes_grid1/anchored_artists.py

Note that the removed imports were restored for this backport so as to
not break the API for 2.0. Whether they really should be moved or not is
a matter for a different PR.
@QuLogic QuLogic mentioned this pull request Oct 16, 2016
@QuLogic
Copy link
Member

QuLogic commented Oct 18, 2016

Backported to v2.x via ef06f5f.

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.

None yet

5 participants