Skip to content

Commit 7aac7fd

Browse files
Figure.inset: Fix typos in docstring of "box" parameter (#2842)
1 parent 9a185f4 commit 7aac7fd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

pygmt/src/inset.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -78,20 +78,20 @@ def inset(self, **kwargs):
7878
[[*dx*/*dy*/][*shade*]]].
7979
If set to ``True``, draw a rectangular box around the map
8080
inset using the default pen; specify a different pen
81-
with **+p**\ *pen*. Add **+g**\ *fill* to fill the logo box
81+
with **+p**\ *pen*. Add **+g**\ *fill* to fill the inset box
8282
[Default is no fill].
83-
Append **+c**\ *clearance* where *clearance* is either
83+
Append **+c**\ *clearance* where *clearance* is either
8484
*gap*, *xgap*\ /\ *ygap*, or *lgap*\ /\ *rgap*\ /\ *bgap*\ /\
8585
*tgap* where these items are uniform, separate in x- and
86-
y-direction, or individual side spacings between logo and border.
87-
Append **+i** to draw a secondary, inner border as well. We use a
88-
uniform *gap* between borders of 2\ **p** and the default pen
86+
y-directions, or individual side spacings between map embellishment
87+
and border. Append **+i** to draw a secondary, inner border as well.
88+
We use a uniform *gap* between borders of 2p and the default pen
8989
unless other values are specified. Append **+r** to draw rounded
9090
rectangular borders instead, with a 6p corner radius. You
9191
can override this radius by appending another value. Append
9292
**+s** to draw an offset background shaded region. Here, *dx*/*dy*
9393
indicates the shift relative to the foreground frame [Default is
94-
``"4p/-4p"``] and ``shade`` sets the fill style to use for
94+
``"4p/-4p"``] and *shade* sets the fill style to use for
9595
shading [Default is ``"gray50"``].
9696
margin : float, str, or list
9797
This is clearance that is added around the inside of the inset.

0 commit comments

Comments
 (0)