Axes doc updates #10599
Merged
Axes doc updates #10599
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
40a86e5 to
0f1089c
Compare
tacaswell
reviewed
Feb 25, 2018
| @@ -4782,41 +4786,38 @@ def arrow(self, x, y, dx, dy, **kwargs): | |||
| """ | |||
| Add an arrow to the axes. | |||
|
|
|||
| Draws arrow on specified axis from (`x`, `y`) to (`x` + `dx`, | |||
There was a problem hiding this comment.
One of these changes is causing:
Warning, treated as error:
/home/circleci/project/lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.arrow:31:Block quote ends without a blank line; unexpected unindent.
Makefile:20: recipe for target 'html' failed
| @@ -3525,6 +3525,10 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None, | |||
|
|
|||
| - ``means``: points or lines representing the means. | |||
|
|
|||
| Notes | |||
| ----- | |||
| .. [Notes section required for data comment. See #10189.] | |||
There was a problem hiding this comment.
I'm guessing this is the source of the problem.
There was a problem hiding this comment.
No, it was an indented %(FancyArrow)s. For now, I've unindented it again, which messes up the Other Parameters section, but at least builds. Might be fixed with #10364.
b6e89c6 to
0cb3061
Compare
anntzer
reviewed
Mar 3, 2018
lib/matplotlib/axes/_axes.py
Outdated
| @@ -4782,41 +4786,38 @@ def arrow(self, x, y, dx, dy, **kwargs): | |||
| """ | |||
| Add an arrow to the axes. | |||
|
|
|||
| Draws arrow on specified axis from (`x`, `y`) to (`x` + `dx`, | |||
| `y` + `dy`). Uses FancyArrow patch to construct the arrow. | |||
| This draws an arrow from (`x`, `y`) to (`x+dx`, `y+dy`). | |||
There was a problem hiding this comment.
double quotes outside, or asterisks inside...
anntzer
approved these changes
Mar 3, 2018
0cb3061 to
0fbc50c
Compare
anntzer
added a commit
that referenced
this pull request
Mar 4, 2018
Backport PR #10599 on branch v2.2.x
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.
PR Summary
Some more docstring updates: