[WIP] DOC Updated documentation of arrow function to numpy docs format. #7029
Conversation
| dy : float | ||
| Length of arrow in y-coordinate | ||
|
|
||
| Return |
There was a problem hiding this comment.
There is a small mistake in the title of this section. It should be Returns (with an s)
|
Apart from my two comments, this is great! |
|
|
||
| **Example:** | ||
| Examples | ||
| -------- | ||
|
|
||
| .. plot:: mpl_examples/pylab_examples/arrow_demo.py |
There was a problem hiding this comment.
Can you please add a blank line after this? I am not entirely sure why, but python3.5 is unhappy…
There was a problem hiding this comment.
Sorry, I wasn't clear: I meant after the ".. plot::" directive.
|
The rendering is now fixed and it looks great! |
|
It appears you had not set the config for your git client initially. Your first commit is attributed to "Your Name you@example.com", which is probably not what you want. |
| y : float | ||
| Y-coordinate of the arrow base | ||
| dx : float | ||
| Length of arrow in x-coordinate |
|
Hi Miguel and Bo, This patch still needs a bit of work. Do you want to finish it or should I take over? Cheers, |
|
I repaired the wording (in > along) and the whitespace as per comments, but I am at a loss about the FancyArrow properties issue. I would appreciate suggestions here. |
|
|
||
| Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*, | ||
| *y* + *dy*). Uses FancyArrow patch to construct the arrow. | ||
| %(FancyArrow)s : Parent object type. |
There was a problem hiding this comment.
Do not put anything after %(FancyArrow)s, that code get templated at import time to be a big tables.
|
CI's not done, but I expect it will pass as the doc build is already done. The first commit still needs rebasing to give it a unique author (which could be done by one of us if given the name/email to use), but modulo that it should be ready. |
|
So now the commits have been rebased to have a unique author and Travis passed, but one of the appveyor builds failed. Can anyone make sense of the .tex error messages? There seems to be a small difference in the generated images of the test_backend_pgf, but I do not see how that relates to the documentation changes. |
The fail in pgf_pdflatex is not related. (it is failing for all build for a while now #7160) |
|
Thanks everyone! |
DOC: Updated documentation of arrow function to numpy docs format.
|
backported to v2.x as 0370181 |
Hi @NelleV,
we tried to update the doc of arrow().
Bye,
Miguel and Bo
@NelleV