Skip to content

Commit 0c16002

Browse files
anntzeranntzer
committed
More rst markup fixes.
1 parent 4dea709 commit 0c16002

File tree

7 files changed

+43
-39
lines changed

7 files changed

+43
-39
lines changed

‎lib/matplotlib/axes/_axes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6802,7 +6802,7 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
68026802
See Also
68036803
--------
68046804
psd
6805-
`psd` plots the power spectral density.`.
6805+
`psd` plots the power spectral density.
68066806
68076807
angle_spectrum
68086808
`angle_spectrum` plots the angles of the corresponding frequencies.

‎lib/matplotlib/axes/_base.py

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -429,24 +429,23 @@ def __init__(self, fig, rect,
429429
**kwargs
430430
):
431431
"""
432-
Build an `Axes` instance in
433-
`~matplotlib.figure.Figure` *fig* with
434-
*rect=[left, bottom, width, height]* in
435-
`~matplotlib.figure.Figure` coordinates
432+
Build an `Axes` instance in `~matplotlib.figure.Figure` *fig* with
433+
*rect=[left, bottom, width, height]* in `~matplotlib.figure.Figure`
434+
coordinates
436435
437436
Optional keyword arguments:
438437
439438
================ =========================================
440439
Keyword Description
441440
================ =========================================
442-
*adjustable* [ 'box' | 'datalim' | 'box-forced']
441+
*adjustable* [ 'box' | 'datalim' | 'box-forced' ]
443442
*alpha* float: the alpha transparency (can be None)
444443
*anchor* [ 'C', 'SW', 'S', 'SE', 'E', 'NE', 'N',
445444
'NW', 'W' ]
446445
*aspect* [ 'auto' | 'equal' | aspect_ratio ]
447446
*autoscale_on* [ *True* | *False* ] whether or not to
448447
autoscale the *viewlim*
449-
*axisbelow* [ *True* | *False* | 'line'] draw the grids
448+
*axisbelow* [ *True* | *False* | 'line' ] draw the grids
450449
and ticks below or above most other artists,
451450
or below lines but above patches
452451
*cursor_props* a (*float*, *color*) tuple
@@ -458,11 +457,11 @@ def __init__(self, fig, rect,
458457
*navigate_mode* [ 'PAN' | 'ZOOM' | None ] the navigation
459458
toolbar button status
460459
*position* [left, bottom, width, height] in
461-
class:`~matplotlib.figure.Figure` coords
462-
*sharex* an class:`~matplotlib.axes.Axes` instance
463-
to share the x-axis with
464-
*sharey* an class:`~matplotlib.axes.Axes` instance
465-
to share the y-axis with
460+
`~matplotlib.figure.Figure` coords
461+
*sharex* an `~matplotlib.axes.Axes` instance to share the
462+
x-axis with
463+
*sharey* an `~matplotlib.axes.Axes` instance to share the
464+
y-axis with
466465
*title* the title string
467466
*visible* [ *True* | *False* ] whether the axes is
468467
visible
@@ -617,9 +616,11 @@ def _init_axis(self):
617616

618617
def set_figure(self, fig):
619618
"""
620-
Set the class:`~matplotlib.axes.Axes` figure
619+
Set the `~matplotlib.axes.Axes` figure.
621620
622-
accepts a class:`~matplotlib.figure.Figure` instance
621+
Parameters
622+
----------
623+
fig : matplotlib.figure.Figure
623624
"""
624625
martist.Artist.set_figure(self, fig)
625626

‎lib/matplotlib/colors.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1595,6 +1595,7 @@ def hillshade(self, elevation, vert_exag=1, dx=1, dy=1, fraction=1.):
15951595
full illumination or shadow (and clipping any values that move
15961596
beyond 0 or 1). Note that this is not visually or mathematically
15971597
the same as vertical exaggeration.
1598+
15981599
Returns
15991600
-------
16001601
intensity : ndarray
@@ -1946,9 +1947,8 @@ def from_levels_and_colors(levels, colors, extend='neither'):
19461947
Parameters
19471948
----------
19481949
levels : sequence of numbers
1949-
The quantization levels used to construct the `BoundaryNorm`.
1950-
Values ``v`` are quantizized to level ``i`` if
1951-
``lev[i] <= v < lev[i+1]``.
1950+
The quantization levels used to construct the `BoundaryNorm`. Values
1951+
``v`` are quantizized to level ``i`` if ``lev[i] <= v < lev[i+1]``.
19521952
colors : sequence of colors
19531953
The fill color to use for each level. If `extend` is "neither" there
19541954
must be ``n_level - 1`` colors. For an `extend` of "min" or "max" add
@@ -1959,8 +1959,7 @@ def from_levels_and_colors(levels, colors, extend='neither'):
19591959
19601960
Returns
19611961
-------
1962-
(cmap, norm) : tuple containing a `Colormap` and a \
1963-
`Normalize` instance
1962+
(cmap, norm) : tuple of a `Colormap` and a `Normalize` instance
19641963
"""
19651964
colors_i0 = 0
19661965
colors_i1 = None

‎lib/matplotlib/font_manager.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,10 +480,12 @@ def ttfFontProperty(font):
480480

481481
def afmFontProperty(fontpath, font):
482482
"""
483-
A function for populating a `FontKey` instance by
484-
extracting information from the AFM font file.
483+
Populate a `FontKey` instance with information from the AFM font file.
485484
486-
*font* is a class:`AFM` instance.
485+
Parameters
486+
----------
487+
fontpath : str
488+
font : AFM
487489
"""
488490

489491
name = font.get_familyname()

‎lib/matplotlib/offsetbox.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,11 @@ def __setstate__(self, state):
174174

175175
def set_figure(self, fig):
176176
"""
177-
Set the figure
177+
Set the figure.
178178
179-
accepts a class:`~matplotlib.figure.Figure` instance
179+
Parameters
180+
----------
181+
fig : matplotlib.figure.Figure
180182
"""
181183
martist.Artist.set_figure(self, fig)
182184
for c in self.get_children():

‎lib/matplotlib/spines.py

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,19 @@ class Spine(mpatches.Patch):
2323
"""an axis spine -- the line noting the data area boundaries
2424
2525
Spines are the lines connecting the axis tick marks and noting the
26-
boundaries of the data area. They can be placed at arbitrary
27-
positions. See function:`~matplotlib.spines.Spine.set_position`
28-
for more information.
26+
boundaries of the data area. They can be placed at arbitrary positions. See
27+
`~matplotlib.spines.Spine.set_position` for more information.
2928
3029
The default position is ``('outward',0)``.
3130
32-
Spines are subclasses of class:`~matplotlib.patches.Patch`, and
33-
inherit much of their behavior.
31+
Spines are subclasses of `~matplotlib.patches.Patch`, and inherit much of
32+
their behavior.
3433
35-
Spines draw a line, a circle, or an arc depending if
36-
function:`~matplotlib.spines.Spine.set_patch_line`,
37-
function:`~matplotlib.spines.Spine.set_patch_circle`, or
38-
function:`~matplotlib.spines.Spine.set_patch_arc` has been called.
39-
Line-like is the default.
34+
Spines draw a line, a circle, or an arc depending
35+
if `~matplotlib.spines.Spine.set_patch_line`,
36+
`~matplotlib.spines.Spine.set_patch_circle`, or
37+
`~matplotlib.spines.Spine.set_patch_arc` has been called. Line-like is the
38+
default.
4039
4140
"""
4241
def __str__(self):

‎lib/matplotlib/transforms.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1637,13 +1637,14 @@ class TransformWrapper(Transform):
16371637

16381638
def __init__(self, child):
16391639
"""
1640-
*child*: A class:`Transform` instance. This child may later
1641-
be replaced with `set`.
1640+
Parameters
1641+
----------
1642+
child : Transform
1643+
This child may later be replaced with `set`.
16421644
"""
16431645
if not isinstance(child, Transform):
1644-
msg = ("'child' must be an instance of"
1645-
" 'matplotlib.transform.Transform'")
1646-
raise ValueError(msg)
1646+
raise ValueError("'child' must be an instance of "
1647+
"'matplotlib.transform.Transform'")
16471648
self._init(child)
16481649
self.set_children(child)
16491650

0 commit comments

Comments
 (0)