8000 Merge pull request #3698 from montefra/axvline_doc · matplotlib/matplotlib@80d0565 · GitHub
[go: up one dir, main page]

Skip to content

Commit 80d0565

Browse files
committed
Merge pull request #3698 from montefra/axvline_doc
DOC : fixed axvline description of ymin/ymax args. Little edit in axhline doc
2 parents dd2a31d + d63313a commit 80d0565

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -684,12 +684,12 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
684684
685685
Returns
686686
-------
687-
`~matplotlib.lines.Line2D`
687+
:class:`~matplotlib.lines.Line2D`
688688
689689
Notes
690690
-----
691-
kwargs are the same as kwargs to plot, and can be
692-
used to control the line properties. e.g.,
691+
kwargs are passed to :class:`~matplotlib.lines.Line2D` and can be used
692+
to control the line properties.
693693
694694
Examples
695695
--------
@@ -702,7 +702,7 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
702702
703703
>>> axhline(y=1)
704704
705-
* draw a default hline at 'y' = .5 that spans the the middle half of
705+
* draw a default hline at 'y' = .5 that spans the middle half of
706706
the xrange::
707707
708708
>>> axhline(y=.5, xmin=0.25, xmax=0.75)
@@ -746,16 +746,16 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
746746
x position in data coordinates of the vertical line.
747747
748748
ymin : scalar, optional, default: 0
749-
Should be between 0 and 1, 0 being the far left of the plot, 1 the
750-
far right of the plot.
749+
Should be between 0 and 1, 0 being the bottom of the plot, 1 the
750+
top of the plot.
751751
752752
ymax : scalar, optional, default: 1
753-
Should be between 0 and 1, 0 being the far left of the plot, 1 the
754-
far right of the plot.
753+
Should be between 0 and 1, 0 being the bottom of the plot, 1 the
754+
top of the plot.
755755
756756
Returns
757757
-------
758-
`~matplotlib.lines.Line2D`
758+
:class:`~matplotlib.lines.Line2D`
759759
760760
761761
Examples

lib/matplotlib/pyplot.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3066,7 +3066,7 @@ def phase_spectrum(x, Fs=None, Fc=None, window=None, pad_to=None, sides=None,
30663066
def pie(x, explode=None, labels=None, colors=None, autopct=None,
30673067
pctdistance=0.6, shadow=False, labeldistance=1.1, startangle=None,
30683068
radius=None, counterclock=True, wedgeprops=None, textprops=None,
3069-
hold=None,center=(0,0),frame=False):
3069+
center=(0, 0), frame=False, hold=None):
30703070
ax = gca()
30713071
# allow callers to override the hold state by passing hold=True|False
30723072
washold = ax.ishold()
@@ -3078,8 +3078,8 @@ def pie(x, explode=None, labels=None, colors=None, autopct=None,
30783078
autopct=autopct, pctdistance=pctdistance, shadow=shadow,
30793079
labeldistance=labeldistance, startangle=startangle,
30803080
radius=radius, counterclock=counterclock,
3081-
wedgeprops=wedgeprops, textprops=textprops,
3082-
center=center,frame=frame)
3081+
wedgeprops=wedgeprops, textprops=textprops, center=center,
3082+
frame=frame)
30833083
draw_if_interactive()
30843084
finally:
30853085
ax.hold(washold)

0 commit comments

Comments
 (0)
0