Use insert_alias for all functions with use_alias

Author: Meghan Jones

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",

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",

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",

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",

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",

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",

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",

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",

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",

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",

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",

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",

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",

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):
     """

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",

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",

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",

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",

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):

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",

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",

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",

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",

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",