DOC: Updating docstring to numpy doc format for errorbar by S-Alvanides · Pull Request #7032 · matplotlib/matplotlib

S-Alvanides · 2016-09-05T15:20:29Z

Hi matplotlib contributor,

we updated the docstring of errorbar to the numpy doc format. @NelleV

Thanks for your patience,
Benedikt and Seraphin

NelleV · 2016-09-05T17:28:34Z

lib/matplotlib/axes/_axes.py


+        Returns
+        -------
+        plotline: :class:`~matplotlib.lines.Line2D` instance


For numpydoc to render properly, you need to add a space after plotline and before ":".

NelleV · 2016-09-05T17:30:13Z

Hello,

Thanks for the patch!
The matplotlib code follows the pep8 recommendations. The patch breaks a couple of these recommendations, mostly whitespace issues. Here is the traceback:

/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2705:19: W291 trailing whitespace
/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2707:1: W293 blank line contains whitespace
/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2708:80: E501 line too long (91 > 79 characters)
/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2764:18: W291 trailing whitespace
/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2766:21: W291 trailing whitespace
/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2767:80: E501 line too long (81 > 79 characters)
/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:2792:1: W293 blank line contains whitespace

NelleV · 2016-09-05T17:31:06Z

lib/matplotlib/axes/_axes.py

-          *xerr*/*yerr*: [ scalar | N, Nx1, or 2xN array-like ]
+        Parameters
+        ----------
+        x : scalar            


There is whitespace at the end of this line. Can you please remove it?

NelleV · 2016-09-05T17:34:01Z

Apart from my comments, great job!

NelleV · 2016-09-05T17:52:46Z

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.

QuLogic · 2016-09-06T04:56:07Z

lib/matplotlib/axes/_axes.py

-        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.


This should remain on a separate line; I think this is causing the rendering issue @NelleV noted.

QuLogic · 2016-09-06T05:02:56Z

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.

daurer · 2016-09-06T18:40:55Z

We tried to address all problems listed. @NelleV @Seraf69

Benedikt and Seraphin

QuLogic · 2016-09-06T21:30:44Z

lib/matplotlib/axes/_axes.py

+        ----------
+        x : scalar
+        y : scalar
+


There are still spaces here.

NelleV · 2016-09-08T13:03:44Z

lib/matplotlib/axes/_axes.py

-        **Example:**

+        Examples
+        -------


You have a tiny problem here: there is a dash missing to underline the whole section.

DOC minor fixes on the documentation of errorbar

NelleV · 2016-09-14T03:00:34Z

This looks good! Thanks for the contribution.
Here is how it looks:

DOC: Updating docstring to numpy doc format for errorbar

tacaswell · 2016-09-14T03:06:57Z

backported to v2.x as 55d7a4f

@Seraf69 Thanks!

mdboom added the status: needs review label Sep 5, 2016

NelleV reviewed Sep 5, 2016
View reviewed changes

QuLogic added the Documentation label Sep 6, 2016

QuLogic reviewed Sep 6, 2016
View reviewed changes

lib/matplotlib/axes/_axes.py Outdated

----------

x : scalar

y : scalar

Copy link
Copy Markdown

Member

QuLogic Sep 6, 2016

Choose a reason for hiding this comment

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

There are still spaces here.

Benedikt Daurer and others added 4 commits September 7, 2016 13:43

[WIP] DOC: Updating docstring to numpy doc format for errorbar

4d2c994

[WIP] DOC: Fixed issues with whitespaces

5ecdb2e

[WIP] DOC: Removed whitespace

d3d5ad0

[WIP] DOC: Shortened a too long line

89c8586

daurer force-pushed the docs_errorbar branch from 88ba41a to 89c8586 Compare September 7, 2016 17:35

Benedikt Daurer added 4 commits September 8, 2016 07:49

[WIP] DOC: Shortened line which was too long

5a9ee00

Removed whitespace

6ab965e

[WIP] DOC: Trying to fix intendation problems

835fec6

[WIP] DOC: Fixed typo

d06853b

NelleV reviewed Sep 8, 2016
View reviewed changes

Benedikt Daurer added 2 commits September 8, 2016 23:49

DOC: Fixing intendation and small formatting problems

96b05e9

DOC: Shortened too long lines

f2f7689

Benedikt Daurer and others added 4 commits September 9, 2016 01:35

DOC: Removed trailling whitespace

8ae6f94

DOC minor fixes on the documentation of errorbar

98f4ac1

Merge pull request #1 from NelleV/Seraf69_docs_errorbar_fix

b5dafba

DOC minor fixes on the documentation of errorbar

DOC: Shortened line to match pep8

bec46f0

NelleV changed the title ~~[WIP] DOC: Updating docstring to numpy doc format for errorbar~~ [MRG+1] DOC: Updating docstring to numpy doc format for errorbar Sep 14, 2016

tacaswell merged commit 38be7ae into matplotlib:master Sep 14, 2016

tacaswell removed the status: needs review label Sep 14, 2016

tacaswell added a commit that referenced this pull request Sep 14, 2016

Merge pull request #7032 from Seraf69/docs_errorbar

55d7a4f

DOC: Updating docstring to numpy doc format for errorbar

QuLogic added this to the 2.0 (style change major release) milestone Sep 14, 2016

daurer deleted the docs_errorbar branch September 14, 2016 06:41

QuLogic changed the title ~~[MRG+1] DOC: Updating docstring to numpy doc format for errorbar~~ DOC: Updating docstring to numpy doc format for errorbar Oct 16, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOC: Updating docstring to numpy doc format for errorbar#7032

DOC: Updating docstring to numpy doc format for errorbar#7032
tacaswell merged 14 commits intomatplotlib:masterfrom
S-Alvanides:docs_errorbar

S-Alvanides commented Sep 5, 2016

Uh oh!

NelleV Sep 5, 2016

Uh oh!

NelleV commented Sep 5, 2016 •

edited by QuLogic

Loading

Uh oh!

NelleV Sep 5, 2016

Uh oh!

NelleV commented Sep 5, 2016

Uh oh!

NelleV commented Sep 5, 2016

Uh oh!

QuLogic Sep 6, 2016

Uh oh!

QuLogic commented Sep 6, 2016

Uh oh!

daurer commented Sep 6, 2016 •

edited

Loading

Uh oh!

QuLogic Sep 6, 2016

Uh oh!

NelleV Sep 8, 2016

Uh oh!

NelleV commented Sep 14, 2016

Uh oh!

tacaswell commented Sep 14, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

S-Alvanides commented Sep 5, 2016

Uh oh!

NelleV Sep 5, 2016

Choose a reason for hiding this comment

Uh oh!

NelleV commented Sep 5, 2016 • edited by QuLogic Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NelleV Sep 5, 2016

Choose a reason for hiding this comment

Uh oh!

NelleV commented Sep 5, 2016

Uh oh!

NelleV commented Sep 5, 2016

Uh oh!

QuLogic Sep 6, 2016

Choose a reason for hiding this comment

Uh oh!

QuLogic commented Sep 6, 2016

Uh oh!

daurer commented Sep 6, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuLogic Sep 6, 2016

Choose a reason for hiding this comment

Uh oh!

NelleV Sep 8, 2016

Choose a reason for hiding this comment

Uh oh!

NelleV commented Sep 14, 2016

Uh oh!

tacaswell commented Sep 14, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

NelleV commented Sep 5, 2016 •

edited by QuLogic

Loading

daurer commented Sep 6, 2016 •

edited

Loading