-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Add documentation for mpl_toolkits.axes_grid1.inset_locator #4864
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
Conversation
Docbuild failure, but I don't know what it means: https://api.travis-ci.org/jobs/74123925/log.txt?deansi=true |
I generated the docs in py3 on my local machine, it turns out the I moved the class-level docstrings to the |
Ok, that makes sense. Don't worry about that usetex test, it is a transient
|
Awesome! I have no problem with this sneaking in under the wire for 1.5, but do not have time to review. |
A question for the other devs... Is there any reason why we continue to have the axes_grid and axes_grid1? From my understanding, axes_grid is "deprecated" and is only kept around for compatibility. Documentation-wise, it looks like only the axes_grid module is actually generated. |
I would be 👍 on removing axes_grid |
Has anyone been able to review this? |
@leejjoon Can you review this? |
from __future__ import (absolute_import, division, print_function, | ||
unicode_literals) | ||
|
||
from matplotlib.externals import six |
There was a problem hiding this comment.
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
Gave this a quick read, looks really good 👍 There are a bunch of places where things need to be put under a In the places where |
Moved __call__ functionality in subclasses to parent class Slight PEP8 cleanup
Fixes Py2k compatibility
Thanks for reviewing this. I don't think the I attempted to do the following in
This doesn't quite get the formatting right either (the start of the description is misaligned with the start of the descriptions of the other parameters). The generated HTML has an extra |
I think the priority should be that the docs render reasonably even if they are not semantically correct. |
Add six import for consistency
782ed8a
to
e6181de
Compare
Okay. I've also double checked the **kwargs options I removed. |
DOC: Add documentation for mpl_toolkits.axes_grid1.inset_locator
This is what the built docs look like http://matplotlib.org/devdocs/mpl_toolkits/axes_grid/api/inset_locator_api.html |
DOC: Add documentation for mpl_toolkits.axes_grid1.inset_locator
back-ported to 1.5.x as 8677af6 |
This module has some nice, undocumented (except in narrative form) helpers that has been interesting to figure out.
I made some formatting changes, and some slight API differences:
AnchoredSizeLocator
andAnchoredZoomLocator
both overrode__call__
merely to save the axes (which is unused inAnchoredSizeLocator
anyways). I moved the saving of this value to the__call__
of their superclass. No other file in matplotlib uses these classes, and the superclass doesn't look used for anything else online.inset_axes
andzoomed_inset_axes
take a**kwarg
, but the only keyworded argument that would not result in an error isborderpad
. I changed the functions to make that clear.I still have
AnchoredLocatorBase
(and its subclasses) to document, but I don't understand the code as is - for instance, a required parameteroffsetbox
is always unused, and I don't understand why a locator object (something used withAxes.set_axes_locator
) would ever have any method except those used by__call__
(making the capabilities inherited fromAnchoredOffsetBox
useless).