Apply NIST SI unit convention to some gallery examples (#1194)

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

Author: 4 people

examples/gallery/embellishments/colorbar.py

@@ -14,7 +14,7 @@
   right.
 - **g**: using map coordinates, e.g. ``position="g170/-45"`` for longitude 170E,
   latitude 45S.
-- **x**: using paper coordinates, e.g. ``position="x5c/7c"`` for 5cm,7cm from anchor
+- **x**: using paper coordinates, e.g. ``position="x5c/7c"`` for 5 cm,7 cm from anchor
   point.
 - **n**: using normalized (0-1) coordinates, e.g. ``position="n0.4/0.8"``.
 
@@ -34,7 +34,7 @@
 fig.colorbar(
     cmap="batlow",
     # Colorbar positioned at map coordinates (g) longitude/latitude 0.3/8.7,
-    # with a length/width (+w) of 4cm by 0.5cm, and plotted horizontally (+h)
+    # with a length/width (+w) of 4 cm by 0.5 cm, and plotted horizontally (+h)
     position="g0.3/8.7+w4c/0.5c+h",
     box=True,
     frame=["x+lTemperature", r"y+l\260C"],
@@ -45,8 +45,8 @@
 fig.colorbar(
     cmap="oleron",
     # Colorbar position justified outside map frame (J) at Middle Right (MR),
-    # offset (+o) by 1cm horizontally and 0cm vertically from anchor point,
-    # with a length/width (+w) of 7cm by 0.5cm and a box for NaN values (+n)
+    # offset (+o) by 1 cm horizontally and 0 cm vertically from anchor point,
+    # with a length/width (+w) of 7 cm by 0.5 cm and a box for NaN values (+n)
     position="JMR+o1c/0c+w7c/0.5c+n+mc",
     # Note that the label 'Elevation' is moved to the opposite side and plotted
     # vertically as a column of text using '+mc' in the position parameter

examples/gallery/embellishments/inset.py

@@ -3,9 +3,9 @@
 -----
 
 The :meth:`pygmt.Figure.inset` method adds an inset figure inside a larger
-figure. The function is called using a ``with`` statement, and its position,
-box, offset, and margin parameters are set. Plotting methods called within the
-``with`` statement are applied to the inset figure.
+figure. The function is called using a ``with`` statement, and its ``position``,
+``box``, ``offset``, and ``margin`` parameters are set. Plotting methods called
+within the ``with`` statement are applied to the inset figure.
 """
 import pygmt
 
@@ -14,10 +14,10 @@
 # "brown", the water to "lightblue", the shorelines width to "thin", and adding a frame
 fig.coast(region="MG+r2", land="brown", water="lightblue", shorelines="thin", frame="a")
 # Create an inset, setting the position to top left, the width to 3.5 centimeters, and
-# the x- and y-offsets to 0.2 centimeters. The margin is set to 0, and the border is "green".
-with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box="+pgreen"):
+# the x- and y-offsets to 0.2 centimeters. The margin is set to 0, and the border is "gold".
+with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box="+pgold"):
     # Create a figure in the inset using coast. This example uses the azimuthal
-    # orthogonal projection centered at 47E, 20S. The land is set to "gray" and
+    # orthogonal projection centered at 47E, 20S. The land color is set to "gray" and
     # Madagascar is highlighted in "red".
     fig.coast(
         region="g", projection="G47/-20/3.5c", land="gray", water="white", dcw="MG+gred"

examples/gallery/embellishments/inset_rectangle_region.py

@@ -3,9 +3,9 @@
 --------------------------------------
 
 The :meth:`pygmt.Figure.inset` method adds an inset figure inside a larger
-figure. The function is called using a ``with`` statement, and its position,
-box, offset, and margin can be customized. Plotting methods called within the
-``with`` statement plot into the inset figure.
+figure. The function is called using a ``with`` statement, and its ``position``,
+``box``, ``offset``, and ``margin`` can be customized. Plotting methods called
+within the ``with`` statement plot into the inset figure.
 """
 
 import pygmt

examples/gallery/images/track_sampling.py

@@ -27,7 +27,7 @@
 fig.basemap(region="g", projection="Cyl_stere/150/-20/15c", frame=True)
 fig.grdimage(grid=grid, cmap="gray")
 fig.coast(land="#666666")
-# Plot the sampled bathymetry points using circles (c) of 0.15 cm
+# Plot the sampled bathymetry points using circles (c) of 0.15 cm size
 # Points are colored using elevation values (normalized for visual purposes)
 fig.plot(
     x=track.longitude,

examples/gallery/lines/line_custom_cpt.py

@@ -15,7 +15,7 @@
 import numpy as np
 import pygmt
 
-# Create a list of values between 20 and 30 with at 0.2 intervals
+# Create a list of values between 20 and 30 with 0.2 intervals
 x = np.arange(start=20, stop=30, step=0.2)
 
 fig = pygmt.Figure()

examples/gallery/lines/linestyles.py

@@ -38,7 +38,7 @@
     "1p,lightblue,-.",  # dash-dotted line
     "2p,blue,..-",  # dot-dot-dashed line
     "2p,tomato,--.",  # dash-dash-dotted line
-    # A pattern of 4-point-long line segment and 2-point-gap between segment,
+    # A pattern of 4-point-long line segments and 2-point-long gaps between segments,
     # with pattern offset by 2 points from the origin
     "2p,tomato,4_2:2p",
 ]:

examples/gallery/lines/vector_heads_tails.py

@@ -26,7 +26,7 @@
 In the following we use the :meth:`pygmt.Figure.plot` method to plot vectors
 with individual heads and tails. We must specify the modifiers (together with
 the vector type, here ``v``, see also
-:doc:`Vector types documentation </gallery/lines/vectors>`)
+:doc:`Vector types documentation </gallery/lines/vector_styles>`)
 by passing the corresponding shortcuts to the ``style`` parameter.
 
 """

examples/gallery/lines/vectors.py renamed to examples/gallery/lines/vector_styles.py

@@ -15,8 +15,8 @@
 y = np.random.uniform(region[2], region[3], 100)
 
 fig = pygmt.Figure()
-# Create a 15x15 cm basemap with a Cartesian projection (X) using the data region
+# Create a 15 cm x 15 cm basemap with a Cartesian projection (X) using the data region
 fig.basemap(region=region, projection="X15c", frame=True)
-# Plot using triangles (i) of 0.5 cm
+# Plot using inverted triangles (i) of 0.5 cm size
 fig.plot(x, y, style="i0.5c", color="black")
 fig.show()