DOC: Updating docstring to numpy doc format for errorbar #7032
Conversation
| subsamples the errorbars. e.g., if errorevery=5, errorbars for | ||
| every 5-th datapoint will be plotted. The data plot itself still | ||
| shows all data points. | ||
|
|
||
| Returns | ||
| ------- | ||
| plotline: :class:`~matplotlib.lines.Line2D` instance |
There was a problem hiding this comment.
For numpydoc to render properly, you need to add a space after plotline and before ":".
|
Hello, Thanks for the patch! /home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2705:19: W291 trailing whitespace |
| *xerr*/*yerr*: [ scalar | N, Nx1, or 2xN array-like ] | ||
| Parameters | ||
| ---------- | ||
| x : scalar |
There was a problem hiding this comment.
There is whitespace at the end of this line. Can you please remove it?
|
Apart from my comments, great job! |
|
There is also a slight problem of rendering: I am not sure what the problem is, but I'll look again once you update the PR with the changes. These might actually fix the rendering problem. |
| Plot *x* versus *y* with error deltas in *yerr* and *xerr*. | ||
| Vertical errorbars are plotted if *yerr* is not *None*. | ||
| Horizontal errorbars are plotted if *xerr* is not *None*. | ||
| """Plot an errorbar graph. |
There was a problem hiding this comment.
This should remain on a separate line; I think this is causing the rendering issue @NelleV noted.
|
It appears you have not set the config for your git client. All your commits are attributed to "Your Name you@example.com", which is probably not what you want. |
|
We tried to address all problems listed. @NelleV @Seraf69 Benedikt and Seraphin |
| ---------- | ||
| x : scalar | ||
| y : scalar | ||
|
|
88ba41a to
89c8586
Compare
|
|
||
| Examples | ||
| ------- |
There was a problem hiding this comment.
You have a tiny problem here: there is a dash missing to underline the whole section.
DOC minor fixes on the documentation of errorbar
|
This looks good! Thanks for the contribution.
|
DOC: Updating docstring to numpy doc format for errorbar
|
backported to v2.x as 55d7a4f @Seraf69 Thanks! |
Hi matplotlib contributor,
we updated the docstring of errorbar to the numpy doc format. @NelleV
Thanks for your patience,
Benedikt and Seraphin