8000 Fix sphinx formatting issues · matplotlib/matplotlib@ea60509 · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit ea60509

Browse files
timhoffmtimhoffm
committed
Fix sphinx formatting issues
1 parent 9244eca commit ea60509

File tree

8 files changed

+28
-28
lines changed

8 files changed

+28
-28
lines changed

‎lib/matplotlib/_layoutgrid.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ def edit_margin_min(self, todo, size, cell=0):
285285
existing minimum it updates the margin size. Fraction of
286286
figure size.
287287
288-
cell: int
288+
cell : int
289289
Cell column or row to edit.
290290
"""
291291

@@ -315,11 +315,11 @@ def edit_all_margins_min(self, todo, size):
315315
316316
Parameters
317317
----------
318-
todo: string (one of 'left', 'right', 'bottom', 'top')
319-
margin to alter.
318+
todo : {'left', 'right', 'bottom', 'top'}
319+
The margin to alter.
320320
321-
size: float
322-
Minimum size of the margin . If it is larger than the
321+
size : float
322+
Minimum size of the margin. If it is larger than the
323323
existing minimum it updates the margin size. Fraction of
324324
figure size.
325325
"""
@@ -333,11 +333,11 @@ def edit_outer_margin_mins(self, margin, ss):
333333
334334
Parameters
335335
----------
336-
margin: dict
336+
margin : dict
337337
size of margins in a dict with keys 'left', 'right', 'bottom',
338338
'top'
339339
340-
ss: SubplotSpec
340+
ss : SubplotSpec
341341
defines the subplotspec these margins should be applied to
342342
"""
343343

‎lib/matplotlib/_mathtext.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ def __init__(self, default_font_prop, mathtext_backend):
8181
"""
8282
Parameters
8383
----------
84-
default_font_prop: `~.font_manager.FontProperties`
84+
default_font_prop : `~.font_manager.FontProperties`
8585
The default non-math font, or the base font for Unicode (generic)
8686
font rendering.
87-
mathtext_backend: `MathtextBackend` subclass
87+
mathtext_backend : `MathtextBackend` subclass
8888
Backend to which rendering is actually delegated.
8989
"""
9090
self.default_font_prop = default_font_prop

‎lib/matplotlib/axes/_axes.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,7 +1012,7 @@ def hlines(self, y, xmin, xmax, colors=None, linestyles='solid',
10121012
See Also
10131013
--------
10141014
vlines : vertical lines
1015-
axhline: horizontal line across the Axes
1015+
axhline : horizontal line across the Axes
10161016
"""
10171017

10181018
# We do the conversion first since not all unitized data is uniform
@@ -1089,7 +1089,7 @@ def vlines(self, x, ymin, ymax, colors=None, linestyles='solid',
10891089
See Also
10901090
--------
10911091
hlines : horizontal lines
1092-
axvline: vertical line across the Axes
1092+
axvline : vertical line across the Axes
10931093
"""
10941094

10951095
# We do the conversion first since not all unitized data is uniform
@@ -2221,7 +2221,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
22212221
22222222
See Also
22232223
--------
2224-
barh: Plot a horizontal bar plot.
2224+
barh : Plot a horizontal bar plot.
22252225
22262226
Notes
22272227
-----
@@ -2490,7 +2490,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
24902490
24912491
See Also
24922492
--------
2493-
bar: Plot a vertical bar plot.
2493+
bar : Plot a vertical bar plot.
24942494
24952495
Notes
24962496
-----
@@ -2831,7 +2831,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
28312831
shadow : bool, default: False
28322832
Draw a shadow beneath the pie.
28332833
2834-
normalize: None or bool, default: None
2834+
normalize : None or bool, default: None
28352835
When *True*, always make a full pie by normalizing x so that
28362836
``sum(x) == 1``. *False* makes a partial pie if ``sum(x) <= 1``
28372837
and raises a `ValueError` for ``sum(x) > 1``.

‎lib/matplotlib/backends/backend_pdf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,9 +451,9 @@ def paint_path(cls, fill, stroke):
451451
452452
Parameters
453453
----------
454-
fill: bool
454+
fill : bool
455455
Fill the path with the fill color.
456-
stroke: bool
456+
stroke : bool
457457
Stroke the outline of the path with the line color.
458458
"""
459459
if stroke:

‎lib/matplotlib/collections.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -836,7 +836,7 @@ def set_alpha(self, alpha):
836836
837837
Parameters
838838
----------
839-
alpha: float or array of float or None
839+
alpha : float or array of float or None
840840
If not None, *alpha* values must be between 0 and 1, inclusive.
841841
If an array is provided, its length must match the number of
842842
elements in the collection. Masked values and nans are not
@@ -1369,7 +1369,7 @@ def __init__(self, segments, # Can be None.
13691369
"""
13701370
Parameters
13711371
----------
1372-
segments: list of array-like
1372+
segments : list of array-like
13731373
A sequence of (*line0*, *line1*, *line2*), where::
13741374
13751375
linen = (x0, y0), (x1, y1), ... (xm, ym)

‎lib/matplotlib/dates.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ def get_epoch():
275275
276276
Returns
277277
-------
278-
epoch: str
278+
epoch : str
279279
String for the epoch (parsable by `numpy.datetime64`).
280280
"""
281281
global _epoch

‎lib/matplotlib/patches.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1288,26 +1288,26 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False,
12881288
"""
12891289
Parameters
12901290
----------
1291-
width: float, default: 0.001
1291+
width : float, default: 0.001
12921292
Width of full arrow tail.
12931293
1294-
length_includes_head: bool, default: False
1294+
length_includes_head : bool, default: False
12951295
True if head is to be counted in calculating the length.
12961296
1297-
head_width: float or None, default: 3*width
1297+
head_width : float or None, default: 3*width
12981298
Total width of the full arrow head.
12991299
1300-
head_length: float or None, default: 1.5*head_width
1300+
head_length : float or None, default: 1.5*head_width
13011301
Length of arrow head.
13021302
1303-
shape: ['full', 'left', 'right'], default: 'full'
1303+
shape : {'full', 'left', 'right'}, default: 'full'
13041304
Draw the left-half, right-half, or full arrow.
13051305
1306-
overhang: float, default: 0
1306+
overhang : float, default: 0
13071307
Fraction that the arrow is swept back (0 overhang means
13081308
triangular shape). Can be negative or greater than one.
13091309
1310-
head_starts_at_zero: bool, default: False
1310+
head_starts_at_zero : bool, default: False
13111311
If True, the head starts being drawn at coordinate 0
13121312
instead of ending at coordinate 0.
13131313

‎lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1699,15 +1699,15 @@ def _generate_normals(self, polygons):
16991699
17001700
Parameters
17011701
----------
1702-
polygons: list of (M_i, 3) array-like, or (..., M, 3) array-like
1702+
polygons : list of (M_i, 3) array-like, or (..., M, 3) array-like
17031703
A sequence of polygons to compute normals for, which can have
17041704
varying numbers of vertices. If the polygons all have the same
17051705
number of vertices and array is passed, then the operation will
17061706
be vectorized.
17071707
17081708
Returns
17091709
-------
1710-
normals: (..., 3) array-like
1710+
normals : (..., 3) array-like
17111711
A normal vector estimated for the polygon.
17121712
17131713
"""

0 commit comments

Comments
 (0)
0