Proofread edits to subplot round 3

Co-Authored-By: Dongdong Tian <seisman.info@gmail.com>

Author: weiji14

examples/tutorials/subplots.py

@@ -207,10 +207,10 @@
     fig.basemap(
         region=[0, 5, 0, 5], projection="X?", frame=["af", "WSne"], panel=[0, 1]
     )
+# Move the plot origin upward by 1 cm
+fig.shift_origin(yshift="h+1c")
 # Top row, one subplot
-with fig.subplot(
-    nrows=1, ncols=1, figsize=("15c", "3c"), autolabel="a)", yshift="h+1c"
-):
+with fig.subplot(nrows=1, ncols=1, figsize=("15c", "3c"), autolabel="a)"):
     fig.basemap(
         region=[0, 10, 0, 10], projection="X?", frame=["af", "WSne"], panel=[0, 0]
     )
@@ -223,14 +223,15 @@
 # We start by drawing the bottom two subplots, setting ``autolabel="b)"`` so
 # that the subplots are labelled 'b)' and 'c)'. Then, we plot a single subplot
 # on the top row by using ``fig.subplot(..., yshift="h+1c")`` which shifts the
-# plot origin 1 cm beyond the **h**\ eight of the previous (bottom row) plot.
-# You may need to adjust this ``yshift`` parameter to make your plot look nice.
-# This top row uses ``autolabel="a)"``, and we also plotted some text inside.
-# Note that ``projection="X?"`` was used to let GMT automatically determine the
-# size of the subplot according to the size of the subplot area.
+# plot origin 1 cm above the **h**\ eight of the entire figure that is
+# currently plotted (i.e. the bottom row subplots). You may need to adjust this
+# ``yshift`` parameter to make your plot look nice. This top row uses
+# ``autolabel="a)"``, and we also plotted some text inside. Note that
+# ``projection="X?"`` was used to let GMT automatically determine the size of
+# the subplot according to the size of the subplot area.
 
 ###############################################################################
 # You can also manually override the ``autolabel`` for each subplot using for
-# example, ``fig.set_panel(..., fixedlabel="b) Panel 2"`` which would allow you
-# to manually label a single subplot as you wish. This can be useful for adding
-# a more descriptive subtitle to individual subplots.
+# example, ``fig.set_panel(..., fixedlabel="b) Panel 2")`` which would allow
+# you to manually label a single subplot as you wish. This can be useful for
+# adding a more descriptive subtitle to individual subplots.

pygmt/src/subplot.py

@@ -54,9 +54,9 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
     ncols : int
         Number of horizontal columns of the subplot grid.
     figsize : tuple
-        Specify the final figure dimensions as ``(width, height)``.
+        Specify the final figure dimensions as (*width*, *height*).
     subsize : tuple
-        Specify the dimensions of each subplot directly as ``(width, height)``.
+        Specify the dimensions of each subplot directly as (*width*, *height*).
         Note that only one of ``figsize`` or ``subsize`` can be provided at
         once.
 
@@ -153,10 +153,10 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
     kwargs["T"] = f'"{kwargs.get("T")}"' if kwargs.get("T") else None
 
     if nrows < 1 or ncols < 1:
-        raise GMTInvalidInput("Please ensure that both `nrows`>=1 and `ncols`>=1.")
+        raise GMTInvalidInput("Please ensure that both 'nrows'>=1 and 'ncols'>=1.")
     if kwargs.get("Ff") and kwargs.get("Fs"):
         raise GMTInvalidInput(
-            "Please provide either one of `figsize` or `subsize` only."
+            "Please provide either one of 'figsize' or 'subsize' only."
         )
 
     with Session() as lib:
@@ -177,12 +177,12 @@ def set_panel(self, panel=None, **kwargs):
     Set the current subplot panel to plot on.
 
     Before you start plotting you must first select the active subplot. Note:
-    If any *projection* option is passed with **?** as scale or width when
-    plotting subplots, then the dimensions of the map are automatically
-    determined by the subplot size and your region. For Cartesian plots: If you
-    want the scale to apply equally to both dimensions then you must specify
-    ``projection="x"`` [The default ``projection="X"`` will fill the subplot by
-    using unequal scales].
+    If any *projection* option is passed with the question mark **?** as scale
+    or width when plotting subplots, then the dimensions of the map are
+    automatically determined by the subplot size and your region. For Cartesian
+    plots: If you want the scale to apply equally to both dimensions then you
+    must specify ``projection="x"`` [The default ``projection="X"`` will fill
+    the subplot by using unequal scales].
 
     {aliases}