8000 Merge pull request #10599 from timhoffm/axes-doc-updates · matplotlib/matplotlib@65ddd82 · GitHub
[go: up one dir, main page]
Skip to content

Commit 65ddd82

Browse files
jklymakjklymak
authored
Merge pull request #10599 from timhoffm/axes-doc-updates
Axes doc updates
2 parents 2bfb08c + 0fbc50c commit 65ddd82

File tree

1 file changed

+40
-39
lines changed

1 file changed

+40
-39
lines changed

‎lib/matplotlib/axes/_axes.py

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -561,16 +561,17 @@ def text(self, x, y, s, fontdict=None, withdash=False, **kwargs):
561561
"""
562562
Add text to the axes.
563563
564-
Add text in string `s` to axis at location `x`, `y`, data
565-
coordinates.
564+
Add the text *s* to the axes at location *x*, *y* in data coordinates.
566565
567566
Parameters
568567
----------
569568
x, y : scalars
570-
data coordinates
569+
The position to place the text. By default, this is in data
570+
coordinates. The coordinate system can be changed using the
571+
*transform* parameter.
571572
572-
s : string
573-
text
573+
s : str
574+
The text.
574575
575576
fontdict : dictionary, optional, default: None
576577
A dictionary to override the default text properties. If fontdict
@@ -580,6 +581,11 @@ def text(self, x, y, s, fontdict=None, withdash=False, **kwargs):
580581
Creates a `~matplotlib.text.TextWithDash` instance instead of a
581582
`~matplotlib.text.Text` instance.
582583
584+
Returns
585+
-------
586+
text : `.Text`
587+
The created `.Text` instance.
588+
583589
Other Parameters
584590
----------------
585591
**kwargs : `~matplotlib.text.Text` properties.
@@ -597,9 +603,8 @@ def text(self, x, y, s, fontdict=None, withdash=False, **kwargs):
597603
lower-left and 1,1 is upper-right). The example below places
598604
text in the center of the axes::
599605
600-
>>> text(0.5, 0.5,'matplotlib', horizontalalignment='center',
601-
... verticalalignment='center',
602-
... transform=ax.transAxes)
606+
>>> text(0.5, 0.5, 'matplotlib', horizontalalignment='center',
607+
... verticalalignment='center', transform=ax.transAxes)
603608
604609
You can put a rectangular box around the text instance (e.g., to
605610
set a background color) by using the keyword `bbox`. `bbox` is
@@ -679,13 +684,8 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
679684
680685
See also
681686
--------
682-
hlines : add horizontal lines in data coordinates
683-
axhspan : add a horizontal span (rectangle) across the axis
684-
685-
Notes
686-
-----
687-
kwargs are passed to :class:`~matplotlib.lines.Line2D` and can be used
688-
to control the line properties.
687+
hlines : Add horizontal lines in data coordinates.
688+
axhspan : Add a horizontal span (rectangle) across the axis.
689689
690690
Examples
691691
--------
@@ -769,8 +769,8 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
769769
770770
See also
771771
--------
772-
vlines : add vertical lines in data coordinates
773-
axvspan : add a vertical span (rectangle) across the axis
772+
vlines : Add vertical lines in data coordinates.
773+
axvspan : Add a vertical span (rectangle) across the axis.
774774
"""
775775

776776
if "transform" in kwargs:
@@ -829,7 +829,7 @@ def axhspan(self, ymin, ymax, xmin=0, xmax=1, **kwargs):
829829
830830
See Also
831831
--------
832-
axvspan : add a vertical span across the axes
832+
axvspan : Add a vertical span across the axes.
833833
"""
834834
trans = self.get_yaxis_transform(which='grid')
835835

@@ -886,7 +886,7 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
886886
887887
See Also
888888
--------
889-
axhspan : add a horizontal span across the axes
889+
axhspan : Add a horizontal span across the axes.
890890
891891
Examples
892892
--------
@@ -3521,6 +3521,10 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
35213521
35223522
- ``means``: points or lines representing the means.
35233523
3524+
Notes
3525+
-----
3526+
.. [Notes section required for data comment. See #10189.]
3527+
35243528
"""
35253529

35263530
# If defined in matplotlibrc, apply the value from rc file
@@ -4778,41 +4782,38 @@ def arrow(self, x, y, dx, dy, **kwargs):
47784782
"""
47794783
Add an arrow to the axes.
47804784
4781-
Draws arrow on specified axis from (`x`, `y`) to (`x` + `dx`,
4782-
`y` + `dy`). Uses FancyArrow patch to construct the arrow.
4785+
This draws an arrow from ``(x, y)`` to ``(x+dx, y+dy)``.
47834786
47844787
Parameters
47854788
----------
4786-
x : float
4787-
X-coordinate of the arrow base
4788-
y : float
4789-
Y-coordinate of the arrow base
4790-
dx : float
4791-
Length of arrow along x-coordinate
4792-
dy : float
4793-
Length of arrow along y-coordinate
4789+
x, y : float
4790+
The x/y-coordinate of the arrow base.
4791+
dx, dy : float
4792+
The length of the arrow along x/y-direction.
47944793
47954794
Returns
47964795
-------
4797-
a : FancyArrow
4798-
patches.FancyArrow object
4796+
arrow : `.FancyArrow`
4797+
The created `.FancyArrow` object.
47994798
48004799
Other Parameters
4801-
-----------------
4802-
Optional kwargs (inherited from FancyArrow patch) control the arrow
4803-
construction and properties:
4800+
----------------
4801+
**kwargs
4802+
Optional kwargs (inherited from `.FancyArrow` patch) control the
4803+
arrow construction and properties:
48044804
48054805
%(FancyArrow)s
48064806
48074807
Notes
48084808
-----
48094809
The resulting arrow is affected by the axes aspect ratio and limits.
48104810
This may produce an arrow whose head is not square with its stem. To
4811-
create an arrow whose head is square with its stem, use
4812-
:meth:`annotate` for example::
4811+
create an arrow whose head is square with its stem,
4812+
use :meth:`annotate` for example:
4813+
4814+
>>> ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
4815+
... arrowprops=dict(arrowstyle="->"))
48134816
4814-
ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
4815-
arrowprops=dict(arrowstyle="->"))
48164817
"""
48174818
# Strip away units for the underlying patch since units
48184819
# do not make sense to most patch-like code
@@ -6172,7 +6173,7 @@ def table(self, **kwargs):
61726173
cellLoc='right', colWidths=None,
61736174
rowLabels=None, rowColours=None, rowLoc='left',
61746175
colLabels=None, colColours=None, colLoc='center',
6175-
loc='bottom', bbox=None):
6176+
loc='bottom', bbox=None)
61766177
61776178
Returns a :class:`matplotlib.table.Table` instance. Either `cellText`
61786179
or `cellColours` must be provided. For finer grained control over

0 commit comments

Comments
 (0)
0