Add alias 'aspatial' to methods blockmedian, info, plot, plot3d, surf…

…ace (#1090) * Add aspatial alias to COMMON_OPTIONS * Add aspatial alias to blockmedian, info, plot, plot3d, surface Co-authored-by: Dongdong Tian <[email protected]>
GenericMappingTools · Mar 21, 2021 · 37ce2f7 · 37ce2f7
1 parent 7a4c763
commit 37ce2f7
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 0 deletions.
diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py
@@ -62,6 +62,12 @@
             Shift plot origin in y-direction. Full documentation is at
             :gmt-docs:`gmt.html#xy-full`.
          """,
+    "a": r"""
+        aspatial : str
+            [*col*\ =]\ *name*\ [,...].
+            Control how aspatial data are handled during input and output.
+            Full documentation is at :gmt-docs:`gmt.html#aspatial-full`.
+         """,
     "c": r"""
         panel : bool or int or list
             [*row,col*\|\ *index*].

diff --git a/pygmt/src/blockmedian.py b/pygmt/src/blockmedian.py
@@ -20,6 +20,7 @@
     I="spacing",
     R="region",
     V="verbose",
+    a="aspatial",
     f="coltypes",
     r="registration",
 )
@@ -58,6 +59,7 @@ def blockmedian(table, outfile=None, **kwargs):
         file.
 
     {V}
+    {a}
     {f}
     {r}
 

diff --git a/pygmt/src/info.py b/pygmt/src/info.py
@@ -18,6 +18,7 @@
     I="spacing",
     T="nearest_multiple",
     V="verbose",
+    a="aspatial",
     f="coltypes",
     r="registration",
 )
@@ -62,6 +63,7 @@ def info(table, **kwargs):
         of dz and output this in the form ``[zmin, zmax, dz]``.
 
     {V}
+    {a}
     {f}
     {r}
 

diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py
@@ -34,6 +34,7 @@
     X="xshift",
     Y="yshift",
     Z="zvalue",
+    a="aspatial",
     i="columns",
     l="label",
     c="panel",
@@ -181,6 +182,7 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
         polygon in the input data. To apply it to the fill color, use
         ``color='+z'``. To apply it to the pen color, append **+z** to
         ``pen``.
+    {a}
     {c}
     {f}
     columns : str or 1d array

diff --git a/pygmt/src/plot3d.py b/pygmt/src/plot3d.py
@@ -34,6 +34,7 @@
     X="xshift",
     Y="yshift",
     Z="zvalue",
+    a="aspatial",
     i="columns",
     l="label",
     c="panel",
@@ -151,6 +152,7 @@ def plot3d(
         polygon in the input data. To apply it to the fill color, use
         ``color='+z'``. To apply it to the pen color, append **+z** to
         ``pen``.
+    {a}
     {c}
     {f}
     label : str

diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py
@@ -22,6 +22,7 @@
     R="region",
     G="outfile",
     V="verbose",
+    a="aspatial",
     f="coltypes",
     r="registration",
 )
@@ -67,6 +68,7 @@ def surface(x=None, y=None, z=None, data=None, **kwargs):
         to store the grid in.
 
     {V}
+    {a}
     {f}
     {r}