From 7aac7fdaddb035ea56bf1c2755844897e98dcf6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= <94163266+yvonnefroehlich@users.noreply.github.com> Date: Sun, 3 Dec 2023 00:34:56 +0100 Subject: [PATCH] Figure.inset: Fix typos in docstring of "box" parameter (#2842) --- pygmt/src/inset.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pygmt/src/inset.py b/pygmt/src/inset.py index e99cc075f59..18fbe7a1aab 100644 --- a/pygmt/src/inset.py +++ b/pygmt/src/inset.py @@ -78,20 +78,20 @@ def inset(self, **kwargs): [[*dx*/*dy*/][*shade*]]]. If set to ``True``, draw a rectangular box around the map inset using the default pen; specify a different pen - with **+p**\ *pen*. Add **+g**\ *fill* to fill the logo box + with **+p**\ *pen*. Add **+g**\ *fill* to fill the inset box [Default is no fill]. - Append **+c**\ *clearance* where *clearance* is either + Append **+c**\ *clearance* where *clearance* is either *gap*, *xgap*\ /\ *ygap*, or *lgap*\ /\ *rgap*\ /\ *bgap*\ /\ *tgap* where these items are uniform, separate in x- and - y-direction, or individual side spacings between logo and border. - Append **+i** to draw a secondary, inner border as well. We use a - uniform *gap* between borders of 2\ **p** and the default pen + y-directions, or individual side spacings between map embellishment + and border. Append **+i** to draw a secondary, inner border as well. + We use a uniform *gap* between borders of 2p and the default pen unless other values are specified. Append **+r** to draw rounded rectangular borders instead, with a 6p corner radius. You can override this radius by appending another value. Append **+s** to draw an offset background shaded region. Here, *dx*/*dy* indicates the shift relative to the foreground frame [Default is - ``"4p/-4p"``] and ``shade`` sets the fill style to use for + ``"4p/-4p"``] and *shade* sets the fill style to use for shading [Default is ``"gray50"``]. margin : float, str, or list This is clearance that is added around the inside of the inset.