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

Skip to content

Commit 7a366bf

Browse files
committed
DOC: Escape **kwargs correctly.
Oddly enough, the example docstring in the napoleon docs does not seem to do this escaping correctly.
1 parent 70f36c0 commit 7a366bf

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

lib/matplotlib/patheffects.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ def __init__(self, offset=(2, -2),
231231
rho : float
232232
A scale factor to apply to the rgbFace color if `shadow_rgbFace`
233233
is not specified. Default is 0.3.
234-
**kwargs
234+
``**kwargs``
235235
Extra keywords are stored and passed through to
236236
:meth:`AbstractPathEffect._update_gc`.
237237
@@ -313,7 +313,7 @@ def __init__(self, offset=(2,-2),
313313
rho : float
314314
A scale factor to apply to the rgbFace color if `shadow_rgbFace`
315315
is ``None``. Default is 0.3.
316-
**kwargs
316+
``**kwargs``
317317
Extra keywords are stored and passed through to
318318
:meth:`AbstractPathEffect._update_gc`.
319319
@@ -374,7 +374,7 @@ def __init__(self, offset=(0, 0), **kwargs):
374374
----------
375375
offset : pair of floats
376376
The offset to apply to the path, in points.
377-
**kwargs :
377+
``**kwargs``
378378
All keyword arguments are passed through to the
379379
:class:`~matplotlib.patches.PathPatch` constructor. The
380380
properties which cannot be overridden are "path", "clip_box"

lib/mpl_toolkits/axes_grid1/inset_locator.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ def __init__(self, bbox, **kwargs):
158158
bbox : `matplotlib.transforms.Bbox`
159159
Bbox to use for the extents of this patch.
160160
161-
**kwargs
161+
``**kwargs``
162162
Patch properties. Valid arguments include:
163163
%(Patch)s
164164
"""
@@ -304,7 +304,7 @@ def __init__(self, bbox1, bbox2, loc1, loc2=None, **kwargs):
304304
'lower left' : 3,
305305
'lower right' : 4
306306
307-
**kwargs
307+
``**kwargs``
308308
Patch properties for the line drawn. Valid arguments include:
309309
%(Patch)s
310310
"""
@@ -358,7 +358,7 @@ def __init__(self, bbox1, bbox2, loc1a, loc2a, loc1b, loc2b, **kwargs):
358358
'lower left' : 3,
359359
'lower right' : 4
360360
361-
**kwargs
361+
``**kwargs``
362362
Patch properties for the line drawn:
363363
%(Patch)s
364364
"""
@@ -568,7 +568,7 @@ def mark_inset(parent_axes, inset_axes, loc1, loc2, **kwargs):
568568
Corners to use for connecting the inset axes and the area in the
569569
parent axes.
570570
571-
**kwargs
571+
``**kwargs``
572572
Patch properties for the lines and box drawn:
573573
%(Patch)s
574574

0 commit comments

Comments
 (0)