Skip to content

Arrow patch docstring clean - #8770

Merged
NelleV merged 2 commits into
matplotlib:masterfrom
dstansby:arrowpatch-docstring
Jul 28, 2017
Merged

NelleV merged 2 commits into
matplotlib:masterfrom
dstansby:arrowpatch-docstring

Conversation

@dstansby

Copy link
Copy Markdown
Member

Make mpatches.Arrow into 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.py to stop some text leaking off the bottom of the plot.

@dstansby dstansby changed the title Arrowpatch docstring clean Arrow patch docstring clean Jun 17, 2017
Comment thread lib/matplotlib/patches.py
"""
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*).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

would do use double backquotes around each parenthesis instead.

@NelleV
NelleV merged commit 1a835d9 into matplotlib:master Jul 28, 2017
@QuLogic QuLogic added this to the 2.1 (next point release) milestone Jul 28, 2017
@dstansby
dstansby deleted the arrowpatch-docstring branch July 29, 2017 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants