From b774df53140318df6d10dcefecd87155cdd36b7d Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 28 Aug 2020 13:01:14 -0400 Subject: [PATCH] Fix description of various -F option (#4099) --- doc/rst/source/basemap_common.rst_ | 4 ++-- doc/rst/source/coast_common.rst_ | 4 ++-- doc/rst/source/colorbar_common.rst_ | 6 +++--- doc/rst/source/image_common.rst_ | 2 +- doc/rst/source/legend_common.rst_ | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/rst/source/basemap_common.rst_ b/doc/rst/source/basemap_common.rst_ index aeb1cf71abc..6c947d8cd0d 100644 --- a/doc/rst/source/basemap_common.rst_ +++ b/doc/rst/source/basemap_common.rst_ @@ -47,10 +47,10 @@ Optional Arguments Without further options, draws a rectangular border around any map inset (**-D**\; classic mode only), map scale (**-L**) or map rose (**-T**) using :term:`MAP_FRAME_PEN`; specify a different pen with **+p**\ *pen*. - Add **+g**\ *fill* to fill the logo box [no fill]. + Add **+g**\ *fill* to fill the box [no fill]. 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. + x- and y-direction, or individual side spacings between map inset/scale/rose and border. Append **+i** to draw a secondary, inner border as well. We use a uniform *gap* between borders of 2\ **p** and the :term:`MAP_DEFAULT_PEN` unless other values are specified. Append **+r** to draw rounded diff --git a/doc/rst/source/coast_common.rst_ b/doc/rst/source/coast_common.rst_ index 933ddd5e61b..3902893ef13 100644 --- a/doc/rst/source/coast_common.rst_ +++ b/doc/rst/source/coast_common.rst_ @@ -94,10 +94,10 @@ Optional Arguments **-F**\ [**l**\|\ **t**][**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]][**+p**\ [*pen*]][**+r**\ [*radius*]][**+s**\ [[*dx*/*dy*/][*shade*]]] Without further options, draws a rectangular border around the map scale or rose using :term:`MAP_FRAME_PEN`; specify a different pen with **+p**\ *pen*. - Add **+g**\ *fill* to fill the logo box [no fill]. + Add **+g**\ *fill* to fill the box [no fill]. 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. + x- and y-direction, or individual side spacings between map scale/rose and border. Append **+i** to draw a secondary, inner border as well. We use a uniform *gap* between borders of 2\ **p** and the :term:`MAP_DEFAULT_PEN` unless other values are specified. Append **+r** to draw rounded diff --git a/doc/rst/source/colorbar_common.rst_ b/doc/rst/source/colorbar_common.rst_ index 55a8a8176a7..d687c8ecb77 100644 --- a/doc/rst/source/colorbar_common.rst_ +++ b/doc/rst/source/colorbar_common.rst_ @@ -104,12 +104,12 @@ Optional Arguments .. _-F: **-F**\ [**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]][**+p**\ [*pen*]][**+r**\ [*radius*]][**+s**\ [[*dx*/*dy*/][*shade*]]] - Without further options, draws a rectangular border around the scale using + Without further options, draws a rectangular border around the colorbar using :term:`MAP_FRAME_PEN`; specify a different pen with **+p**\ *pen*. - Add **+g**\ *fill* to fill the scale panel [no fill]. + Add **+g**\ *fill* to fill the colorbar panel [no fill]. 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 scale and border. + x- and y-direction, or individual side spacings between colorbar and border. Append **+i** to draw a secondary, inner border as well. We use a uniform *gap* between borders of 2\ **p** and the :term:`MAP_DEFAULT_PEN` unless other values are specified. Append **+r** to draw rounded diff --git a/doc/rst/source/image_common.rst_ b/doc/rst/source/image_common.rst_ index 8ca5f2542bd..1be0a3a8589 100644 --- a/doc/rst/source/image_common.rst_ +++ b/doc/rst/source/image_common.rst_ @@ -61,7 +61,7 @@ Optional Arguments Add **+g**\ *fill* to fill the image box [no fill]. 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 scale and border. + x- and y-direction, or individual side spacings between image and border. Append **+i** to draw a secondary, inner border as well. We use a uniform *gap* between borders of 2\ **p** and the :term:`MAP_DEFAULT_PEN` unless other values are specified. Append **+r** to draw rounded diff --git a/doc/rst/source/legend_common.rst_ b/doc/rst/source/legend_common.rst_ index 1642a52f89b..9f8cd703066 100644 --- a/doc/rst/source/legend_common.rst_ +++ b/doc/rst/source/legend_common.rst_ @@ -55,7 +55,7 @@ Optional Arguments Add **+g**\ *fill* to fill the legend box [no fill]. 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 scale and border. + x- and y-direction, or individual side spacings between legend and border. Append **+i** to draw a secondary, inner border as well. We use a uniform *gap* between borders of 2\ **p** and the :term:`MAP_DEFAULT_PEN` unless other values are specified. Append **+r** to draw rounded