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

Skip to content

Commit 88ee53c

Browse files
stilley2stilley2
committed
Remove astriks from keword arg doc strings
1 parent 0507459 commit 88ee53c

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

‎lib/matplotlib/figure.py‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -169,23 +169,23 @@ def __init__(self, left=None, bottom=None, right=None, top=None,
169169
170170
The following attributes are available
171171
172-
*left* : 0.125
172+
left : 0.125
173173
The left side of the subplots of the figure
174174
175-
*right* : 0.9
175+
right : 0.9
176176
The right side of the subplots of the figure
177177
178-
*bottom* : 0.1
178+
bottom : 0.1
179179
The bottom of the subplots of the figure
180180
181-
*top* : 0.9
181+
top : 0.9
182182
The top of the subplots of the figure
183183
184-
*wspace* : 0.2
184+
wspace : 0.2
185185
The amount of width reserved for blank space between subplots,
186186
expressed as a fraction of the average axis width
187187
188-
*hspace* : 0.2
188+
hspace : 0.2
189189
The amount of height reserved for white space between subplots,
190190
expressed as a fraction of the average axis height
191191
"""
@@ -513,16 +513,16 @@ def suptitle(self, t, **kwargs):
513513
kwargs are :class:`matplotlib.text.Text` properties. Using figure
514514
coordinates, the defaults are:
515515
516-
*x* : 0.5
516+
x : 0.5
517517
The x location of the text in figure coords
518518
519-
*y* : 0.98
519+
y : 0.98
520520
The y location of the text in figure coords
521521
522-
*horizontalalignment* : 'center'
522+
horizontalalignment : 'center'
523523
The horizontal alignment of the text
524524
525-
*verticalalignment* : 'top'
525+
verticalalignment : 'top'
526526
The vertical alignment of the text
527527
528528
If the `fontproperties` keyword argument is given then the
@@ -1316,67 +1316,67 @@ def legend(self, handles, labels, *args, **kwargs):
13161316
13171317
Keyword arguments:
13181318
1319-
*prop*: [ *None* | FontProperties | dict ]
1319+
prop: [ *None* | FontProperties | dict ]
13201320
A :class:`matplotlib.font_manager.FontProperties`
13211321
instance. If *prop* is a dictionary, a new instance will be
13221322
created with *prop*. If *None*, use rc settings.
13231323
1324-
*numpoints*: integer
1324+
numpoints: integer
13251325
The number of points in the legend line, default is 4
13261326
1327-
*scatterpoints*: integer
1327+
scatterpoints: integer
13281328
The number of points in the legend line, default is 4
13291329
1330-
*scatteryoffsets*: list of floats
1330+
scatteryoffsets: list of floats
13311331
a list of yoffsets for scatter symbols in legend
13321332
1333-
*markerscale*: [ *None* | scalar ]
1333+
markerscale: [ *None* | scalar ]
13341334
The relative size of legend markers vs. original. If *None*, use rc
13351335
settings.
13361336
1337-
*markerfirst*: [ *True* | *False* ]
1337+
markerfirst: [ *True* | *False* ]
13381338
if *True*, legend marker is placed to the left of the legend label
13391339
if *False*, legend marker is placed to the right of the legend
13401340
label
13411341
1342-
*frameon*: [ *None* | bool ]
1342+
frameon: [ *None* | bool ]
13431343
Control whether the legend should be drawn on a patch (frame).
13441344
Default is *None* which will take the value from the
13451345
``legend.frameon`` :data:`rcParam<matplotlib.rcParams>`.
13461346
1347-
*fancybox*: [ *None* | *False* | *True* ]
1347+
fancybox: [ *None* | *False* | *True* ]
13481348
if *True*, draw a frame with a round fancybox. If *None*, use rc
13491349
1350-
*shadow*: [ *None* | *False* | *True* ]
1350+
shadow: [ *None* | *False* | *True* ]
13511351
If *True*, draw a shadow behind legend. If *None*, use rc settings.
13521352
1353-
*framealpha*: [ *None* | float ]
1353+
framealpha: [ *None* | float ]
13541354
Control the alpha transparency of the legend's background.
13551355
Default is *None* which will take the value from the
13561356
``legend.framealpha`` :data:`rcParam<matplotlib.rcParams>`.
13571357
1358-
*facecolor*: [ *None* | "inherit" | a color spec ]
1358+
facecolor: [ *None* | "inherit" | a color spec ]
13591359
Control the legend's background color.
13601360
Default is *None* which will take the value from the
13611361
``legend.facecolor`` :data:`rcParam<matplotlib.rcParams>`.
13621362
If ``"inherit"``, it will take the ``axes.facecolor``
13631363
:data:`rcParam<matplotlib.rcParams>`.
13641364
1365-
*edgecolor*: [ *None* | "inherit" | a color spec ]
1365+
edgecolor: [ *None* | "inherit" | a color spec ]
13661366
Control the legend's background patch edge color.
13671367
Default is *None* which will take the value from the
13681368
``legend.edgecolor`` :data:`rcParam<matplotlib.rcParams>`.
13691369
If ``"inherit"``, it will take the ``axes.edgecolor``
13701370
:data:`rcParam<matplotlib.rcParams>`.
13711371
1372-
*ncol* : integer
1372+
ncol : integer
13731373
number of columns. default is 1
13741374
1375-
*mode* : [ "expand" | *None* ]
1375+
mode : [ "expand" | *None* ]
13761376
if mode is "expand", the legend will be horizontally expanded
13771377
to fill the axes area (or *bbox_to_anchor*)
13781378
1379-
*title* : string
1379+
title : string
13801380
the legend title
13811381
13821382
Padding and spacing between various elements use following keywords
@@ -1840,13 +1840,13 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None,
18401840
18411841
Parameters:
18421842
1843-
*pad* : float
1843+
pad : float
18441844
padding between the figure edge and the edges of subplots,
18451845
as a fraction of the font-size.
1846-
*h_pad*, *w_pad* : float
1846+
h_pad, w_pad : float
18471847
padding (height/width) between edges of adjacent subplots.
18481848
Defaults to `pad_inches`.
1849-
*rect* : if rect is given, it is interpreted as a rectangle
1849+
rect : if rect is given, it is interpreted as a rectangle
18501850
(left, bottom, right, top) in the normalized figure
18511851
coordinate that the whole subplots area (including
18521852
labels) will fit into. Default is (0, 0, 1, 1).

0 commit comments

Comments
 (0)