Change "triple"/"quadruple" to "triplet"/"quadruplet" in the documentation (#2186)

Author: yvonnefroehlich

examples/gallery/embellishments/colorbar.py

@@ -14,8 +14,8 @@
   ``position="jTR"`` for top 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 5 cm,7 cm from
-  anchor point.
+- **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"``.
 
 Note that the anchor point defaults to the bottom left (**BL**). Append ``+h``

pygmt/helpers/decorators.py

@@ -144,8 +144,8 @@
         nodata : str
             **i**\|\ **o**\ *nodata*.
             Substitute specific values with NaN (for tabular data). For
-            example, ``d="-9999"`` will replace all values equal to -9999 with
-            NaN during input and all NaN values with -9999 during output.
+            example, ``nodata="-9999"`` will replace all values equal to -9999
+            with NaN during input and all NaN values with -9999 during output.
             Prepend **i** to the *nodata* value for input columns only. Prepend
             **o** to the *nodata* value for output columns only.""",
     "panel": r"""

pygmt/src/blockm.py

@@ -1,5 +1,6 @@
 """
-blockm - Block average (x,y,z) data tables by mean, median, or mode estimation.
+blockm - Block average (x, y, z) data tables by mean, median, or mode
+estimation.
 """
 import pandas as pd
 from pygmt.clib import Session
@@ -16,10 +17,10 @@
 
 def _blockm(block_method, data, x, y, z, outfile, **kwargs):
     r"""
-    Block average (x,y,z) data tables by mean, median, or mode estimation.
+    Block average (x, y, z) data tables by mean, median, or mode estimation.
 
-    Reads arbitrarily located (x,y,z) triples [or optionally weighted
-    quadruples (x,y,z,w)] from a table and writes to the output a mean,
+    Reads arbitrarily located (x, y, z) triplets [or optionally weighted
+    quadruplets (x, y, z, w)] from a table and writes to the output a mean,
     median, or mode (depending on ``block_method``) position and value for
     every non-empty block in a grid region defined by the ``region`` and
     ``spacing`` parameters.
@@ -88,14 +89,14 @@ def _blockm(block_method, data, x, y, z, outfile, **kwargs):
 @kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma", o="sequence_comma")
 def blockmean(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     r"""
-    Block average (x,y,z) data tables by mean estimation.
+    Block average (x, y, z) data tables by mean estimation.
 
-    Reads arbitrarily located (x,y,z) triples [or optionally weighted
-    quadruples (x,y,z,w)] and writes to the output a mean position and value
-    for every non-empty block in a grid region defined by the ``region`` and
-    ``spacing`` parameters.
+    Reads arbitrarily located (x, y, z) triplets [or optionally weighted
+    quadruplets (x, y, z, w)] and writes to the output a mean position and
+    value for every non-empty block in a grid region defined by the ``region``
+    and ``spacing`` parameters.
 
-    Takes a matrix, xyz triplets, or a file name as input.
+    Takes a matrix, (x, y, z) triplets, or a file name as input.
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
@@ -184,14 +185,14 @@ def blockmean(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
 @kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma", o="sequence_comma")
 def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     r"""
-    Block average (x,y,z) data tables by median estimation.
+    Block average (x, y, z) data tables by median estimation.
 
-    Reads arbitrarily located (x,y,z) triples [or optionally weighted
-    quadruples (x,y,z,w)] and writes to the output a median position and value
-    for every non-empty block in a grid region defined by the ``region`` and
-    ``spacing`` parameters.
+    Reads arbitrarily located (x, y, z) triplets [or optionally weighted
+    quadruplets (x, y, z, w)] and writes to the output a median position and
+    value for every non-empty block in a grid region defined by the ``region``
+    and ``spacing`` parameters.
 
-    Takes a matrix, xyz triplets, or a file name as input.
+    Takes a matrix, (x, y, z) triplets, or a file name as input.
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
@@ -271,14 +272,14 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
 @kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma", o="sequence_comma")
 def blockmode(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     r"""
-    Block average (x,y,z) data tables by mode estimation.
+    Block average (x, y, z) data tables by mode estimation.
 
-    Reads arbitrarily located (x,y,z) triples [or optionally weighted
-    quadruples (x,y,z,w)] and writes to the output a mode position and value
-    for every non-empty block in a grid region defined by the ``region`` and
-    ``spacing`` parameters.
+    Reads arbitrarily located (x, y, z) triplets [or optionally weighted
+    quadruplets (x, y, z, w)] and writes to the output a mode position and
+    value for every non-empty block in a grid region defined by the ``region``
+    and ``spacing`` parameters.
 
-    Takes a matrix, xyz triplets, or a file name as input.
+    Takes a matrix, (x, y, z) triplets, or a file name as input.
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 

pygmt/src/contour.py

@@ -38,10 +38,10 @@ def contour(self, data=None, x=None, y=None, z=None, **kwargs):
     r"""
     Contour table data by direct triangulation.
 
-    Takes a matrix, (x,y,z) triplets, or a file name as input and plots lines,
-    polygons, or symbols at those locations on a map.
+    Takes a matrix, (x, y, z) triplets, or a file name as input and plots,
+    lines, polygons, or symbols at those locations on a map.
 
-    Must provide either ``data`` or ``x``/``y``/``z``.
+    Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
     Full option list at :gmt-docs:`contour.html`
 

pygmt/src/nearneighbor.py

@@ -1,5 +1,5 @@
 """
-nearneighbor - Grid table data using a "Nearest neighbor" algorithm
+nearneighbor - Grid table data using a "Nearest neighbor" algorithm.
 """
 
 from pygmt.clib import Session
@@ -40,7 +40,7 @@ def nearneighbor(data=None, x=None, y=None, z=None, **kwargs):
     r"""
     Grid table data using a "Nearest neighbor" algorithm.
 
-    **nearneighbor** reads arbitrarily located (*x,y,z*\ [,\ *w*]) triples
+    **nearneighbor** reads arbitrarily located (*x*, *y*, *z*\ [, *w*]) triplets
     [quadruplets] and uses a nearest neighbor algorithm to assign a weighted
     average value to each node that has one or more data points within a search
     radius centered on the node with adequate coverage across a subset of the
@@ -67,7 +67,7 @@ def nearneighbor(data=None, x=None, y=None, z=None, **kwargs):
        Only the closest point in each sector (red circles) contribute to the
        weighted estimate.
 
-    Takes a matrix, xyz triples, or a file name as input.
+    Takes a matrix, (x, y, z) triplets, or a file name as input.
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 

pygmt/src/plot3d.py

@@ -58,13 +58,13 @@ def plot3d(
     r"""
     Plot lines, polygons, and symbols in 3-D.
 
-    Takes a matrix, (x,y,z) triplets, or a file name as input and plots
+    Takes a matrix, (x, y, z) triplets, or a file name as input and plots
     lines, polygons, or symbols at those locations in 3-D.
 
-    Must provide either ``data`` or ``x``/``y``/``z``.
+    Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
-    If providing data through ``x/y/z``, ``fill`` can be a 1d array
-    that will be mapped to a colormap.
+    If providing data through ``x``, ``y``, and ``z``, ``fill`` can be a
+    1d array that will be mapped to a colormap.
 
     If a symbol is selected and no symbol size given, then plot3d will
     interpret the fourth column of the input data as symbol size. Symbols

pygmt/src/project.py

@@ -43,7 +43,7 @@ def project(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     the input (beyond the required :math:`x` and :math:`y` columns).
 
     Alternatively, ``project`` may be used to generate
-    :math:`(r, s, p)` triples at equal increments along a profile using the
+    :math:`(r, s, p)` triplets at equal increments along a profile using the
     ``generate`` parameter. In this case, the value of ``data`` is ignored
     (you can use, e.g., ``data=None``).
 

pygmt/src/surface.py

@@ -36,15 +36,15 @@ def surface(data=None, x=None, y=None, z=None, **kwargs):
     r"""
     Grids table data using adjustable tension continuous curvature splines.
 
-    Surface reads randomly-spaced (x,y,z) triples and produces gridded values
-    z(x,y) by solving:
+    Surface reads randomly-spaced (x, y, z) triplets and produces gridded
+    values z(x,y) by solving:
 
     .. math::    (1 - t)\nabla^2(z)+t\nabla(z) = 0
 
     where :math:`t` is a tension factor between 0 and 1, and :math:`\nabla`
     indicates the Laplacian operator.
 
-    Takes a matrix, xyz triples, or a file name as input.
+    Takes a matrix, (x, y, z) triplets, or a file name as input.
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 

pygmt/src/wiggle.py

@@ -36,10 +36,10 @@ def wiggle(self, data=None, x=None, y=None, z=None, **kwargs):
     r"""
     Plot z=f(x,y) anomalies along tracks.
 
-    Takes a matrix, (x,y,z) triplets, or a file name as input and plots z as a
-    function of distance along track.
+    Takes a matrix, (x, y, z) triplets, or a file name as input and plots z
+    as a function of distance along track.
 
-    Must provide either ``data`` or ``x``/``y``/``z``.
+    Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
     Full option list at :gmt-docs:`wiggle.html`