Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c765573

Browse files
committed
Fix scatter docstring markup
1 parent 1928c38 commit c765573

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3804,20 +3804,21 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
38043804
verts=None, edgecolors=None,
38053805
**kwargs):
38063806
"""
3807-
Make a scatter plot of `x` vs `y`.
3807+
Make a scatter plot of *x* vs *y*.
38083808
3809-
Marker size is scaled by `s` and marker color is mapped to `c`.
3809+
Marker size is scaled by *s* and marker color is mapped to *c*.
38103810
38113811
Parameters
38123812
----------
38133813
x, y : array_like, shape (n, )
38143814
Input data
38153815
38163816
s : scalar or array_like, shape (n, ), optional
3817-
size in points^2. Default is `rcParams['lines.markersize'] ** 2`.
3817+
Size in points**2.
3818+
Default is ``rcParams['lines.markersize'] ** 2``.
38183819
38193820
c : color, sequence, or sequence of color, optional, default: 'b'
3820-
`c` can be a single color format string, or a sequence of color
3821+
*c* can be a single color format string, or a sequence of color
38213822
specifications of length `N`, or a sequence of `N` numbers to be
38223823
mapped to colors using the `cmap` and `norm` specified via kwargs
38233824
(see below). Note that `c` should not be a single numeric RGB or
@@ -3828,48 +3829,48 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
38283829
38293830
marker : `~matplotlib.markers.MarkerStyle`, optional, default: 'o'
38303831
See `~matplotlib.markers` for more information on the different
3831-
styles of markers scatter supports. `marker` can be either
3832+
styles of markers scatter supports. *marker* can be either
38323833
an instance of the class or the text shorthand for a particular
38333834
marker.
38343835
38353836
cmap : `~matplotlib.colors.Colormap`, optional, default: None
38363837
A `~matplotlib.colors.Colormap` instance or registered name.
3837-
`cmap` is only used if `c` is an array of floats. If None,
3838-
defaults to rc `image.cmap`.
3838+
*cmap* is only used if *c* is an array of floats. If ``None``,
3839+
defaults to rc ``image.cmap``.
38393840
38403841
norm : `~matplotlib.colors.Normalize`, optional, default: None
38413842
A `~matplotlib.colors.Normalize` instance is used to scale
3842-
luminance data to 0, 1. `norm` is only used if `c` is an array of
3843-
floats. If `None`, use the default :func:`normalize`.
3843+
luminance data to 0, 1. *norm* is only used if *c* is an array of
3844+
floats. If ``None``, use the default :func:`normalize`.
38443845
38453846
vmin, vmax : scalar, optional, default: None
3846-
`vmin` and `vmax` are used in conjunction with `norm` to normalize
3847-
luminance data. If either are `None`, the min and max of the
3848-
color array is used. Note if you pass a `norm` instance, your
3849-
settings for `vmin` and `vmax` will be ignored.
3847+
*vmin* and *vmax* are used in conjunction with *norm* to normalize
3848+
luminance data. If either are ``None``, the min and max of the
3849+
color array is used. Note if you pass a *norm* instance, your
3850+
settings for *vmin* and *vmax* will be ignored.
38503851
38513852
alpha : scalar, optional, default: None
38523853
The alpha blending value, between 0 (transparent) and 1 (opaque)
38533854
38543855
linewidths : scalar or array_like, optional, default: None
3855-
If None, defaults to (lines.linewidth,).
3856+
If ``None``, defaults to ``(lines.linewidth,)``.
38563857
38573858
verts : sequence of (x, y), optional
3858-
If `marker` is None, these vertices will be used to
3859+
If *marker* is ``None``, these vertices will be used to
38593860
construct the marker. The center of the marker is located
38603861
at (0,0) in normalized units. The overall marker is rescaled
3861-
by ``s``.
3862+
by *s*.
38623863
38633864
edgecolors : color or sequence of color, optional, default: None
3864-
If None, defaults to 'face'
3865+
If ``None``, defaults to 'face'.
38653866
38663867
If 'face', the edge color will always be the same as
38673868
the face color.
38683869
3869-
If it is 'none', the patch boundary will not
3870+
If 'none', the patch boundary will not
38703871
be drawn.
38713872
3872-
For non-filled markers, the `edgecolors` kwarg
3873+
For non-filled markers, the *edgecolors* kwarg
38733874
is ignored and forced to 'face' internally.
38743875
38753876
Returns
@@ -3882,23 +3883,23 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
38823883
38833884
See Also
38843885
--------
3885-
plot : to plot scatter plots when markers are identical in size and
3886-
color
3886+
plot : To plot scatter plots when markers are identical in size and
3887+
color.
38873888
38883889
Notes
38893890
-----
38903891
38913892
* The `plot` function will be faster for scatterplots where markers
38923893
don't vary in size or color.
38933894
3894-
* Any or all of `x`, `y`, `s`, and `c` may be masked arrays, in which
3895+
* Any or all of *x*, *y*, *s*, and *c* may be masked arrays, in which
38953896
case all masks will be combined and only unmasked points will be
38963897
plotted.
38973898
3898-
Fundamentally, scatter works with 1-D arrays; `x`, `y`, `s`, and `c`
3899+
Fundamentally, scatter works with 1-D arrays; *x*, *y*, *s*, and *c*
38993900
may be input as 2-D arrays, but within scatter they will be
3900-
flattened. The exception is `c`, which will be flattened only if its
3901-
size matches the size of `x` and `y`.
3901+
flattened. The exception is *c*, which will be flattened only if its
3902+
size matches the size of *x* and *y*.
39023903
39033904
"""
39043905

0 commit comments

Comments
 (0)