Update region and projection standard docstrings (#1510)

Modify the COMMON_OPTIONS text for region and projection to
remove the "Required if this is the first plot command" text, but
adding it solely to `basemap`, `coast` and `text` where it is actually
required.

Co-authored-by: Meghan Jones <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>

Author: 3 people

pygmt/helpers/decorators.py

@@ -17,12 +17,10 @@
 COMMON_OPTIONS = {
     "R": r"""
         region : str or list
-            *Required if this is the first plot command*.
             *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
             Specify the :doc:`region </tutorials/regions>` of interest.""",
     "J": r"""
         projection : str
-            *Required if this is the first plot command*.
             *projcode*\[*projparams*/]\ *width*.
             Select map :doc:`projection </projections/index>`.""",
     "A": r"""
@@ -448,11 +446,9 @@ def fmt_docstring(module_func):
         data variables, or a :class:`geopandas.GeoDataFrame` containing the
         tabular data.
     region : str or list
-        *Required if this is the first plot command*.
         *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
         Specify the :doc:`region </tutorials/regions>` of interest.
     projection : str
-        *Required if this is the first plot command*.
         *projcode*\[*projparams*/]\ *width*.
         Select map :doc:`projection </projections/index>`.
     <BLANKLINE>

pygmt/src/basemap.py

@@ -55,6 +55,7 @@ def basemap(self, **kwargs):
     zscale/zsize : float or str
         Set z-axis scaling or z-axis size.
     {R}
+        *Required if this is the first plot command.*
     {B}
     map_scale : str
         [**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\

pygmt/src/coast.py

@@ -65,6 +65,7 @@ def coast(self, **kwargs):
     ----------
     {J}
     {R}
+        *Required if this is the first plot command.*
     {A}
     {B}
     lakes : str or list

pygmt/src/text.py

@@ -117,6 +117,7 @@ def text_(
         then the input to ``textfiles`` must have this as a column.
     {J}
     {R}
+        *Required if this is the first plot command.*
     clearance : str
         [*dx/dy*][**+to**\|\ **O**\|\ **c**\|\ **C**].
         Adjust the clearance between the text and the surrounding box