Wrap grdinfo aliases

pygmt/modules.py

@@ -11,14 +11,16 @@
     data_kind,
     dummy_context,
     fmt_docstring,
+    kwargs_to_strings,
     use_alias,
 )
 
 
 @fmt_docstring
-@use_alias(V="verbose")
+@use_alias(C="tab", F="geographic", L="zdata", M="zextemes", R="region", V="verbose")
+@kwargs_to_strings(R="sequence")
 def grdinfo(grid, **kwargs):
-    """
+    r"""
     Get information about a grid.
 
     Can read the grid from a file or given as an xarray.DataArray grid.
@@ -29,6 +31,18 @@ def grdinfo(grid, **kwargs):
     ----------
     grid : str or xarray.DataArray
         The file name of the input grid or the grid loaded as a DataArray.
+        This is the only required argument.
+    {R}
+    tab : str or bool
+        **n**\ |**t**
+        Formats the report using tab-separated fields on a single line. The
+        output is name w e s n z0 z1 dx dy nx ny[ x0 y0 x1 y1 ] [ med scale ]
+        [mean std rms] [n_nan] registration gtype. The data in brackets are
+        outputted depending on the ``zdata`` and ``zextremes`` arguments.
+        Use **t** to place file name at the end of the output record or,
+        **n** or ``True`` to only output numerical columns. The registration is
+        either 0 (gridline) or 1 (pixel), while gtype is either 0 (Cartesian)
+        or 1 (geographic). The default value is ``False``.
 
     {V}
 

pygmt/tests/test_grdinfo.py

@@ -13,15 +13,15 @@ def test_grdinfo():
     Make sure grd info works as expected.
     """
     grid = load_earth_relief(registration="gridline")
-    result = grdinfo(grid, L=0, C="n")
+    result = grdinfo(grid=grid, L=0, C="n")
     assert result.strip() == "-180 180 -90 90 -8592.5 5559 1 1 361 181 0 1"
 
 
 def test_grdinfo_file():
     """
     Test grdinfo with file input.
     """
-    result = grdinfo("@earth_relief_01d", L=0, C="n")
+    result = grdinfo(grid="@earth_relief_01d", L=0, C="n")
     assert result.strip() == "-180 180 -90 90 -8182 5651.5 1 1 360 180 1 1"