DOC/Gallery example "Configuring PyGMT defaults": General improvements (#3633)

Author: yvonnefroehlich

examples/tutorials/advanced/configuration.py

@@ -2,8 +2,7 @@
 Configuring PyGMT defaults
 ==========================
 
-Default GMT parameters can be set globally or locally using
-:class:`pygmt.config`.
+Default GMT parameters can be set globally or locally using :class:`pygmt.config`.
 """
 
 # %%
@@ -13,9 +12,9 @@
 # Configuring default GMT parameters
 # ----------------------------------
 #
-# Users can override default parameters either temporarily (locally) or
-# permanently (globally) using :class:`pygmt.config`. The full list of default
-# parameters that can be changed can be found at :gmt-docs:`gmt.conf.html`.
+# Users can override default parameters either temporarily (locally) or permanently
+# (globally) using :class:`pygmt.config`. The full list of default parameters that can
+# be changed can be found at :gmt-docs:`gmt.conf.html`.
 #
 # We demonstrate the usage of :class:`pygmt.config` by configuring a map plot.
 
@@ -31,18 +30,17 @@
 # Globally overriding defaults
 # ----------------------------
 #
-# The ``MAP_FRAME_TYPE`` parameter specifies the style of map frame to use, of
-# which there are 5 options: ``fancy`` (default, see above), ``fancy+``,
-# ``plain``, ``graph`` (which does not apply to geographical maps) and
-# ``inside``.
+# The ``MAP_FRAME_TYPE`` parameter specifies the style of map frame to use, of which
+# there are 5 options: ``fancy`` (default, see above), ``fancy+``, ``plain``, ``graph``
+# (which does not apply to geographical maps) and ``inside``.
 #
-# The ``FORMAT_GEO_MAP`` parameter controls the format of geographical tick
-# annotations. The default uses degrees and minutes. Here we specify the ticks
-# to be a decimal number of degrees.
+# The ``FORMAT_GEO_MAP`` parameter controls the format of geographical tick annotations.
+# The default uses degrees and minutes. Here we specify the ticks to be a decimal number
+# of degrees.
 
 fig = pygmt.Figure()
 
-# Configuration for the 'current figure'.
+# Configuration for the 'current figure'
 pygmt.config(MAP_FRAME_TYPE="plain")
 pygmt.config(FORMAT_GEO_MAP="ddd.xx")
 
@@ -56,14 +54,13 @@
 # Locally overriding defaults
 # ---------------------------
 #
-# It is also possible to temporarily override the default parameters, which is
-# very useful for limiting the scope of changes to a particular plot.
-# :class:`pygmt.config` is implemented as a context manager, which handles the
-# setup and teardown of a GMT session. Python users are likely familiar with
-# the ``with open(...) as file:`` snippet, which returns a ``file`` context
-# manager. In this way, it can be used to override a parameter for a single
-# command, or a sequence of commands. An application of :class:`pygmt.config`
-# as a context manager is shown below:
+# It is also possible to temporarily override the default parameters, which is very
+# useful for limiting the scope of changes to a particular plot. :class:`pygmt.config`
+# is implemented as a context manager, which handles the setup and teardown of a GMT
+# session. Python users are likely familiar with the ``with open(...) as file:``
+# snippet, which returns a ``file`` context manager. In this way, it can be used to
+# override a parameter for a single command, or a sequence of commands. An application
+# of :class:`pygmt.config` as a context manager is shown below:
 
 fig = pygmt.Figure()
 
@@ -72,8 +69,8 @@
     fig.basemap(region=[115, 119.5, 4, 7.5], projection="M10c", frame=True)
 fig.coast(land="black", water="skyblue")
 
-# Shift plot origin down by 10cm to plot another map
-fig.shift_origin(yshift="-10c")
+# Shift plot origin down by the height of the figure to plot another map
+fig.shift_origin(yshift="-h")
 
 # This figure retains the default "fancy" frame
 fig.basemap(region=[115, 119.5, 4, 7.5], projection="M10c", frame=True)