Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Axes doc updates #10599

Merged
merged 3 commits into from Mar 4, 2018

Conversation

Projects
None yet
7 participants
@timhoffm
Copy link
Member

commented Feb 25, 2018

PR Summary

Some more docstring updates:

  • ax/hvlines() and axh/vspan()
  • boxplot()
  • text / annotate methods.

@timhoffm timhoffm force-pushed the timhoffm:axes-doc-updates branch from 40a86e5 to 0f1089c Feb 25, 2018

@tacaswell tacaswell added this to the v2.2.0 milestone 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`,

This comment has been minimized.

Copy link
@tacaswell

tacaswell Feb 25, 2018

Member

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

This comment has been minimized.

Copy link
@dopplershift

dopplershift Feb 26, 2018

Contributor

I'm guessing this is the source of the problem.

This comment has been minimized.

Copy link
@timhoffm

timhoffm Feb 27, 2018

Author Member

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.

@tacaswell tacaswell modified the milestones: v2.2.0, v2.2.1 Feb 26, 2018

@timhoffm timhoffm force-pushed the timhoffm:axes-doc-updates branch 2 times, most recently from b6e89c6 to 0cb3061 Feb 27, 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`,
`y` + `dy`). Uses FancyArrow patch to construct the arrow.
This draws an arrow from (`x`, `y`) to (`x+dx`, `y+dy`).

This comment has been minimized.

Copy link
@anntzer

anntzer Mar 3, 2018

Contributor

double quotes outside, or asterisks inside...

@anntzer

anntzer approved these changes Mar 3, 2018

Copy link
Contributor

left a comment

one markup element could be fixed but it's not a regression and the rest is an improvement

@timhoffm timhoffm force-pushed the timhoffm:axes-doc-updates branch from 0cb3061 to 0fbc50c Mar 3, 2018

@jklymak jklymak merged commit 65ddd82 into matplotlib:master Mar 4, 2018

7 of 8 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
ci/circleci: docs-python35 Your tests passed on CircleCI!
Details
ci/circleci: docs-python36 Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing 755e05e...0fbc50c
Details
codecov/project/library 67.12% (target 50%)
Details
codecov/project/tests 98.38% remains the same compared to 755e05e
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
lgtm analysis: Python No alert changes
Details

meeseeksdev bot pushed a commit that referenced this pull request Mar 4, 2018

anntzer added a commit that referenced this pull request Mar 4, 2018

@timhoffm timhoffm deleted the timhoffm:axes-doc-updates branch Mar 4, 2018

@QuLogic QuLogic modified the milestones: v2.2.1, v2.2.0 Mar 4, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.