Clean up legend docstrings #9946
Merged
Conversation
This file contains hidden or 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
tacaswell
approved these changes
Dec 6, 2017
anntzer
reviewed
Dec 6, 2017
lib/matplotlib/legend.py
Outdated
| @@ -1107,16 +1117,16 @@ def set_title(self, title, prop=None): | ||
| self.stale = True | ||
|
|
||
| def get_title(self): | ||
| 'return Text instance for the legend title' | ||
| 'Return `~.text,.Text` instance for the legend title.' |
There was a problem hiding this comment.
typo :-)
(sorry that joke is getting old)
anntzer
reviewed
Dec 6, 2017
lib/matplotlib/legend.py
Outdated
| *bbox* can be | ||
|
|
||
| - A `BboxBase` instance | ||
| - A tuple of ``[left, bottom, width, height]`` in the given transform |
There was a problem hiding this comment.
use parentheses for tuples? :)
a32bc7c to
aac4d2b
Compare
jklymak
reviewed
Dec 7, 2017
lib/matplotlib/legend.py
Outdated
|
|
||
| *bbox* can be | ||
|
|
||
| - A `BboxBase` instance |
lib/matplotlib/legend.py
Outdated
| @@ -1258,7 +1272,7 @@ def draggable(self, state=None, use_blit=False, update="loc"): | ||
| * False : turn draggable off | ||
|
|
||
| If draggable is on, you can drag the legend on the canvas with | ||
| the mouse. The DraggableLegend helper instance is returned if | ||
| the mouse. The `DraggableLegend` helper instance is returned if |
|
@dstansby I just pushed to your branch (which I'm 99.9% sure you said was OK in the past). Feel free to revert if you don't like it. I'll commit if the checks pass... |
|
I'm always happy for small doc fixes to be pushed to my branches, thanks a lot! |
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.
No description provided.