DOC/MNT: Throwing some docstrings at axes_rgb.py #4564
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -33,10 +33,12 @@ def __init__(self, axes): | |||
|
|
|||
| def __getitem__(self, k): | |||
| if isinstance(k, tuple): | |||
| r = SimpleChainedObjects([dict.__getitem__(self, k1) for k1 in k]) | |||
| r = SimpleChainedObjects( | |||
| [super(Axes.AxisDict, self).__getitem__(self, k1) | |||
There was a problem hiding this comment.
super(cls, self) returns the bound method so you don't need the second self.
There was a problem hiding this comment.
Couldn't I also just do super(Axes.AxisDict, self)[k1] here? dict subclassing is still a mystery to me
There was a problem hiding this comment.
Yes, super()[k] would also work.
In my learning how to use axes_rgb.py, I ended up writing some docstrings. Hope this is useful.
Fixed a sloppy copy/paste in py2/py3 compatible reraising
Not entirely clear on what the code at the bottom of lib/mpl_toolkits/axes_grid1/mpl_axes.py is supposed to do, but at least it will run now...
| try: | ||
| axes_class = kwargs.pop("axes_class", self._defaultAxesClass) | ||
| except AttributeError: | ||
| new_msg = ("A subclass of RGBAxesBase must have a " |
There was a problem hiding this comment.
hmmm. _defaultAxesClass is private, in general I'm not in favour of this defensive style, but I accept that this message would have been very helpful for you at some point. I wont hold the PR up for this though.
pelson
added a commit
that referenced
this pull request
Jul 1, 2015
DOC/MNT: Throwing some docstrings at axes_rgb.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In my learning how to use axes_rgb.py, I ended up writing some
docstrings. Hope this is useful.