Arrow patch docstring clean #8770
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
anntzer
reviewed
Jun 18, 2017
|
|
||
| @docstring.dedent_interpd | ||
| def __init__(self, x, y, dx, dy, width=1.0, **kwargs): | ||
| """ | ||
| Draws an arrow, starting at (*x*, *y*), direction and length | ||
| given by (*dx*, *dy*) the width of the arrow is scaled by *width*. | ||
| Draws an arrow from (*x*, *y*) to (*x* + *dx*, *y* + *dy*). |
There was a problem hiding this comment.
would do use double backquotes around each parenthesis instead.
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.
Make
mpatches.Arrowinto a numpydoc docstring, and make it clear the units and size that the patch is drawn in.Also gives a minor clean to
artist_reference.pyto stop some text leaking off the bottom of the plot.