Fix typos in tutorial and docs "text.py" (#2191)

Author: yvonnefroehlich

examples/tutorials/basics/text.py

@@ -2,7 +2,7 @@
 Plotting text
 =============
 
-It is often useful to add annotations to a map plot. This is handled by
+It is often useful to add annotations to a plot. This is handled by
 :meth:`pygmt.Figure.text`.
 """
 # sphinx_gallery_thumbnail_number = 3
@@ -20,18 +20,18 @@
 #
 # Here we create a simple map and add an annotation using the ``text``, ``x``,
 # and ``y`` parameters to specify the annotation text and position in the
-# projection frame. ``text`` accepts *str* types, while ``x``, and ``y``
-# accepts either *int* or *float* numbers, or a list/array of numbers.
+# projection frame. ``text`` accepts *str* types, while ``x`` and ``y``
+# accept either *int* or *float* numbers, or a list/array of numbers.
 
 fig = pygmt.Figure()
 with pygmt.config(MAP_FRAME_TYPE="plain"):
     fig.basemap(region=[108, 120, -5, 8], projection="M20c", frame="a")
 fig.coast(land="black", water="skyblue")
 
-# Plot text annotations using a single element
+# Plot text annotations using single arguments
 fig.text(text="SOUTH CHINA SEA", x=112, y=6)
 
-# Plot text annotations using lists of elements
+# Plot text annotations using lists of arguments
 fig.text(text=["CELEBES SEA", "JAVA SEA"], x=[119, 112], y=[3.25, -4.6])
 
 fig.show()
@@ -61,7 +61,7 @@
 # -------------------------
 #
 # It is also possible to add annotations from a file containing ``x``, ``y``,
-# and ``text`` fields. Here we give a complete example.
+# and ``text`` columns. Here we give a complete example.
 
 fig = pygmt.Figure()
 with pygmt.config(MAP_FRAME_TYPE="plain"):
@@ -97,8 +97,8 @@
 # being added to a plot. The following code segment demonstrates the
 # positioning of the anchor point relative to the text.
 #
-# The anchor is specified with a two letter (order independent) code, chosen
-# from:
+# The anchor point is specified with a two-letter (order independent) code,
+# chosen from:
 #
 # * Vertical anchor: **T**\(op), **M**\(iddle), **B**\(ottom)
 # * Horizontal anchor: **L**\(eft), **C**\(entre), **R**\(ight)
@@ -117,8 +117,8 @@
 ###############################################################################
 # ``angle`` parameter
 # -------------------
-# ``angle`` is an optional parameter used to specify the clockwise rotation of
-# the text from the horizontal.
+# ``angle`` is an optional parameter used to specify the counter-clockwise
+# rotation in degrees of the text from the horizontal.
 
 fig = pygmt.Figure()
 fig.basemap(region=[0, 4, 0, 4], projection="X5c", frame="WSen")

pygmt/src/text.py

@@ -81,20 +81,20 @@ def text_(
         records with (x, y[, angle, font, justify], text).
     x/y : float or 1d arrays
         The x and y coordinates, or an array of x and y coordinates to plot
-        the text
+        the text.
     position : str
-        Sets reference point on the map for the text by using x,y
+        Sets reference point on the map for the text by using x, y
         coordinates extracted from ``region`` instead of providing them
-        through ``x``/``y``. Specify with a two letter (order independent)
+        through ``x``/``y``. Specify with a two-letter (order independent)
         code, chosen from:
 
         * Horizontal: **L**\ (eft), **C**\ (entre), **R**\ (ight)
         * Vertical: **T**\ (op), **M**\ (iddle), **B**\ (ottom)
 
-        For example, ``position="TL"`` plots the text at the Upper Left corner
+        For example, ``position="TL"`` plots the text at the Top Left corner
         of the map.
     text : str or 1d array
-        The text string, or an array of strings to plot on the figure
+        The text string, or an array of strings to plot on the figure.
     angle: int, float, str or bool
         Set the angle measured in degrees counter-clockwise from
         horizontal (e.g. 30 sets the text at 30 degrees). If no angle is
@@ -110,11 +110,12 @@ def text_(
         columns.
     justify : str or bool
         Set the alignment which refers to the part of the text string that
-        will be mapped onto the (x,y) point. Choose a 2 character
+        will be mapped onto the (x, y) point. Choose a two-letter
         combination of **L**, **C**, **R** (for left, center, or right) and
-        **T**, **M**, **B** for top, middle, or bottom. E.g., **BL** for lower
-        left. If no justification is explicitly given (i.e. ``justify=True``),
-        then the input to ``textfiles`` must have this as a column.
+        **T**, **M**, **B** (for top, middle, or bottom). E.g., **BL** for
+        bottom left. If no justification is explicitly given
+        (i.e. ``justify=True``), then the input to ``textfiles`` must have
+        this as a column.
     {projection}
     {region}
         *Required if this is the first plot command.*
@@ -125,7 +126,7 @@ def text_(
         specified. Append the unit you want (*c* for cm, *i* for inch, or *p*
         for point; if not given we consult :gmt-term:`PROJ_LENGTH_UNIT`)
         or *%* for a percentage of the font size. Optionally, use modifier
-        **+t** to set the shape of the textbox when using ``fill`` and/or
+        **+t** to set the shape of the text box when using ``fill`` and/or
         ``pen``. Append lower case **o** to get a straight rectangle
         [Default is **o**]. Append upper case **O** to get a rounded
         rectangle. In paragraph mode (*paragraph*) you can also append lower
@@ -136,7 +137,8 @@ def text_(
         no fill].
     offset : str
         [**j**\|\ **J**]\ *dx*\[/*dy*][**+v**\[*pen*]].
-        Offsets the text from the projected (x,y) point by *dx*,\ *dy* [0/0].
+        Offsets the text from the projected (x, y) point by *dx*/\ *dy*
+        [Default is ``"0/0"``].
         If *dy* is not specified then it is set equal to *dx*. Use **j** to
         offset the text away from the point instead (i.e., the text
         justification will determine the direction of the shift). Using
@@ -148,7 +150,7 @@ def text_(
         Sets the pen used to draw a rectangle around the text string
         (see ``clearance``) [Default is ``"0.25p,black,solid"``].
     no_clip : bool
-        Do NOT clip text at map boundaries [Default is will clip].
+        Do NOT clip text at map boundaries [Default is with clip].
     {timestamp}
     {verbose}
     {xyshift}