Use insert_alias for all functions with use_alias

GenericMappingTools · May 22, 2021 · d3a046e · d3a046e
1 parent c6477d7
commit d3a046e
Show file tree

Hide file tree

Showing 35 changed files with 161 additions and 15 deletions.
diff --git a/pygmt/figure.py b/pygmt/figure.py
@@ -16,6 +16,7 @@
 from pygmt.helpers import (
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     launch_external_viewer,
     unique_name,
@@ -124,6 +125,7 @@ def region(self):
         return wesn
 
     @fmt_docstring
+    @insert_alias
     @use_alias(
         A="crop",
         C="gs_option",

diff --git a/pygmt/src/basemap.py b/pygmt/src/basemap.py
@@ -8,12 +8,14 @@
     args_in_kwargs,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/coast.py b/pygmt/src/coast.py
@@ -8,12 +8,14 @@
     args_in_kwargs,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/colorbar.py b/pygmt/src/colorbar.py
@@ -3,10 +3,17 @@
 """
 
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/contour.py b/pygmt/src/contour.py
@@ -9,12 +9,14 @@
     data_kind,
     dummy_context,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="annotation",
     B="frame",

diff --git a/pygmt/src/grd2cpt.py b/pygmt/src/grd2cpt.py
@@ -4,10 +4,17 @@
 
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="transparency",
     C="cmap",

diff --git a/pygmt/src/grdclip.py b/pygmt/src/grdclip.py
@@ -8,12 +8,14 @@
     GMTTempFile,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     G="outgrid",
     R="region",

diff --git a/pygmt/src/grdcontour.py b/pygmt/src/grdcontour.py
@@ -2,10 +2,17 @@
 grdcontour - Plot a contour figure.
 """
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="annotation",
     B="frame",

diff --git a/pygmt/src/grdcut.py b/pygmt/src/grdcut.py
@@ -8,12 +8,14 @@
     GMTTempFile,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     G="outgrid",
     R="region",

diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py
@@ -8,12 +8,14 @@
     GMTTempFile,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="mode",
     G="outgrid",

diff --git a/pygmt/src/grdfilter.py b/pygmt/src/grdfilter.py
@@ -8,12 +8,14 @@
     GMTTempFile,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     D="distance",
     F="filter",

diff --git a/pygmt/src/grdimage.py b/pygmt/src/grdimage.py
@@ -2,10 +2,17 @@
 grdimage - Plot grids or images.
 """
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="img_out",
     B="frame",

diff --git a/pygmt/src/grdinfo.py b/pygmt/src/grdinfo.py
@@ -6,12 +6,14 @@
     GMTTempFile,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     C="per_column",
     D="tiles",

diff --git a/pygmt/src/grdtrack.py b/pygmt/src/grdtrack.py
@@ -9,11 +9,13 @@
     build_arg_string,
     data_kind,
     fmt_docstring,
+    insert_alias,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(V="verbose", f="coltypes", n="interpolation")
 def grdtrack(points, grid, newcolname=None, outfile=None, **kwargs):
     """

diff --git a/pygmt/src/grdview.py b/pygmt/src/grdview.py
@@ -9,12 +9,14 @@
     build_arg_string,
     data_kind,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/histogram.py b/pygmt/src/histogram.py
@@ -2,10 +2,17 @@
 Histogram - Create a histogram
 """
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="horizontal",
     B="frame",

diff --git a/pygmt/src/image.py b/pygmt/src/image.py
@@ -2,10 +2,17 @@
 image - Plot an image.
 """
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/info.py b/pygmt/src/info.py
@@ -7,12 +7,14 @@
     GMTTempFile,
     build_arg_string,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     C="per_column",
     I="spacing",

diff --git a/pygmt/src/inset.py b/pygmt/src/inset.py
@@ -4,11 +4,18 @@
 import contextlib
 
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
 @contextlib.contextmanager
+@insert_alias
 @use_alias(D="position", F="box", M="margin", N="no_clip", V="verbose")
 @kwargs_to_strings(D="sequence", M="sequence")
 def inset(self, **kwargs):

diff --git a/pygmt/src/legend.py b/pygmt/src/legend.py
@@ -8,12 +8,14 @@
     build_arg_string,
     data_kind,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/logo.py b/pygmt/src/logo.py
@@ -3,10 +3,17 @@
 """
 
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/makecpt.py b/pygmt/src/makecpt.py
@@ -3,10 +3,17 @@
 """
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
-from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
+from pygmt.helpers import (
+    build_arg_string,
+    fmt_docstring,
+    insert_alias,
+    kwargs_to_strings,
+    use_alias,
+)
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="transparency",
     C="cmap",

diff --git a/pygmt/src/meca.py b/pygmt/src/meca.py
@@ -11,6 +11,7 @@
     data_kind,
     dummy_context,
     fmt_docstring,
+    insert_alias,
     kwargs_to_strings,
     use_alias,
 )
@@ -95,6 +96,7 @@ def data_format_code(convention, component="full"):
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     R="region",
     J="projection",

diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py
@@ -8,13 +8,15 @@
     data_kind,
     deprecate_parameter,
     fmt_docstring,
+    insert_alias,
     is_nonstr_iter,
     kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
+@insert_alias
 @use_alias(
     A="straight_line",
     B="frame",