Update the one-sentence description of wrappers to match upstream documentation (#3857)

Author: seisman

pygmt/src/basemap.py

@@ -1,5 +1,5 @@
 """
-basemap - Plot base maps and frames for the figure.
+basemap - Plot base maps and frames.
 """
 
 from pygmt.clib import Session
@@ -26,7 +26,7 @@
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def basemap(self, **kwargs):
     r"""
-    Plot base maps and frames for the figure.
+    Plot base maps and frames.
 
     Creates a basic or fancy basemap with axes, fill, and titles. Several
     map projections are available, and the user may specify separate

pygmt/src/binstats.py

@@ -1,5 +1,5 @@
 """
-binstats - Bin spatial data and determine statistics per bin
+binstats - Bin spatial data and determine statistics per bin.
 """
 
 import xarray as xr

pygmt/src/coast.py

@@ -1,5 +1,5 @@
 """
-coast - Plot land and water.
+coast - Plot continents, countries, shorelines, rivers, and borders.
 """
 
 from pygmt.clib import Session
@@ -39,7 +39,7 @@
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def coast(self, **kwargs):
     r"""
-    Plot continents, shorelines, rivers, and borders on maps.
+    Plot continents, countries, shorelines, rivers, and borders.
 
     Plots grayshaded, colored, or textured land masses [or water masses] on
     maps and [optionally] draws coastlines, rivers, and political

pygmt/src/colorbar.py

@@ -1,5 +1,5 @@
 """
-colorbar - Plot a colorbar.
+colorbar - Plot gray scale or color scale bar.
 """
 
 from pygmt.clib import Session
@@ -32,7 +32,7 @@
 )
 def colorbar(self, **kwargs):
     r"""
-    Plot colorbars on figures.
+    Plot gray scale or color scale bar.
 
     Both horizontal and vertical colorbars are supported. For CPTs with
     gradational colors (i.e., the lower and upper boundary of an interval

pygmt/src/config.py

@@ -1,5 +1,5 @@
 """
-config - set GMT defaults globally or locally.
+config - Change GMT default settings globally or locally.
 """
 
 from inspect import Parameter, Signature
@@ -10,18 +10,18 @@
 
 class config:  # noqa: N801
     """
-    Set GMT defaults globally or locally.
+    Change GMT default settings globally or locally.
 
-    Change GMT defaults globally::
+    Change GMT default settings globally::
 
         pygmt.config(PARAMETER=value)
 
-    Change GMT defaults locally by using it as a context manager::
+    Change GMT default settings locally by using it as a context manager::
 
         with pygmt.config(PARAMETER=value):
             ...
 
-    Full GMT defaults list at :gmt-docs:`gmt.conf.html`
+    Full GMT defaults list at :gmt-docs:`gmt.conf.html`.
     """
 
     # Manually set the __signature__ attribute to enable tab autocompletion

pygmt/src/contour.py

@@ -1,5 +1,5 @@
 """
-contour - Plot contour table data.
+contour - Contour table data by direct triangulation.
 """
 
 from pygmt.clib import Session

pygmt/src/dimfilter.py

@@ -22,7 +22,7 @@
 @kwargs_to_strings(I="sequence", R="sequence")
 def dimfilter(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
     r"""
-    Filter a grid by dividing the filter circle.
+    Directional filtering of grids in the space domain.
 
     Filter a grid in the space (or time) domain by
     dividing the given filter circle into the given number of sectors,

pygmt/src/filter1d.py

@@ -1,5 +1,5 @@
 """
-filter1d - Time domain filtering of 1-D data tables
+filter1d - Time domain filtering of 1-D data tables.
 """
 
 from typing import Literal

pygmt/src/grd2cpt.py

@@ -1,5 +1,5 @@
 """
-grd2cpt - Create a CPT from a grid file.
+grd2cpt - Make linear or histogram-equalized color palette table from grid.
 """
 
 from pygmt.clib import Session
@@ -33,7 +33,7 @@
 @kwargs_to_strings(G="sequence", L="sequence", R="sequence", T="sequence")
 def grd2cpt(grid, **kwargs):
     r"""
-    Make GMT color palette tables from a grid file.
+    Make linear or histogram-equalized color palette table from grid.
 
     This function will help you to make static color palette tables (CPTs).
     By default, the CPT will be saved as the current CPT of the session,

pygmt/src/grd2xyz.py

@@ -1,5 +1,5 @@
 """
-grd2xyz - Convert grid to data table
+grd2xyz - Convert grid to data table.
 """
 
 from typing import Literal

pygmt/src/grdclip.py

@@ -1,5 +1,5 @@
 """
-grdclip - Change the range and extremes of grid values.
+grdclip - Clip the range of grid values.
 """
 
 import xarray as xr
@@ -27,7 +27,7 @@
 )
 def grdclip(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
     r"""
-    Set values in a grid that meet certain criteria to a new value.
+    Clip the range of grid values.
 
     Produce a clipped ``outgrid`` or :class:`xarray.DataArray` version of the
     input ``grid`` file.

pygmt/src/grdcontour.py

@@ -1,5 +1,5 @@
 """
-grdcontour - Plot a contour figure.
+grdcontour - Make contour map using a grid.
 """
 
 from pygmt.clib import Session
@@ -38,7 +38,7 @@
 @kwargs_to_strings(R="sequence", L="sequence", c="sequence_comma", p="sequence")
 def grdcontour(self, grid, **kwargs):
     r"""
-    Convert grids or images to contours and plot them on maps.
+    Make contour map using a grid.
 
     Takes a grid file name or an :class:`xarray.DataArray` object as input.
 

pygmt/src/grdcut.py

@@ -1,5 +1,5 @@
 """
-grdcut - Extract subregion from a grid.
+grdcut - Extract subregion from a grid or image or a slice from a cube.
 """
 
 from typing import Literal
@@ -33,7 +33,7 @@ def grdcut(
     grid, kind: Literal["grid", "image"] = "grid", outgrid: str | None = None, **kwargs
 ) -> xr.DataArray | None:
     r"""
-    Extract subregion from a grid or image.
+    Extract subregion from a grid or image or a slice from a cube.
 
     Produce a new ``outgrid`` file which is a subregion of ``grid``. The
     subregion is specified with ``region``; the specified range must not exceed

pygmt/src/grdgradient.py

@@ -32,7 +32,7 @@
 @kwargs_to_strings(A="sequence", E="sequence", R="sequence")
 def grdgradient(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
     r"""
-    Compute the directional derivative of the vector gradient of the data.
+    Compute directional gradients from a grid.
 
     Can accept ``azimuth``, ``direction``, and ``radiance`` input to create
     the resulting gradient.

pygmt/src/grdimage.py

@@ -1,5 +1,5 @@
 """
-grdimage - Plot grids or images.
+grdimage - Project and plot grids or images.
 """
 
 from pygmt.clib import Session

pygmt/src/grdinfo.py

@@ -1,5 +1,5 @@
 """
-grdinfo - Retrieve info about grid file.
+grdinfo - Extract information from 2-D grids or 3-D cubes.
 """
 
 from pygmt.clib import Session
@@ -28,7 +28,7 @@
 @kwargs_to_strings(D="sequence", I="sequence", R="sequence")
 def grdinfo(grid, **kwargs):
     r"""
-    Get information about a grid.
+    Extract information from 2-D grids or 3-D cubes.
 
     Can read the grid from a file or given as an :class:`xarray.DataArray` grid.
 

pygmt/src/grdlandmask.py

@@ -1,5 +1,5 @@
 """
-grdlandmask - Create a "wet-dry" mask grid from shoreline data base
+grdlandmask - Create a "wet-dry" mask grid from shoreline database.
 """
 
 import xarray as xr
@@ -25,7 +25,7 @@
 @kwargs_to_strings(I="sequence", R="sequence", N="sequence", E="sequence")
 def grdlandmask(outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
     r"""
-    Create a grid file with set values for land and water.
+    Create a "wet-dry" mask grid from shoreline database.
 
     Read the selected shoreline database and create a grid to specify which
     nodes in the specified grid are over land or over water. The nodes defined

pygmt/src/grdproject.py

@@ -27,7 +27,7 @@
 @kwargs_to_strings(C="sequence", D="sequence", R="sequence")
 def grdproject(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
     r"""
-    Change projection of gridded data between geographical and rectangular.
+    Forward and inverse map transformation of grids.
 
     This method will project a geographical gridded data set onto a
     rectangular grid. If ``inverse`` is ``True``, it will project a

pygmt/src/grdsample.py

@@ -1,5 +1,5 @@
 """
-grdsample - Resample a grid onto a new lattice
+grdsample - Resample a grid onto a new lattice.
 """
 
 import xarray as xr
@@ -23,7 +23,7 @@
 @kwargs_to_strings(I="sequence", R="sequence")
 def grdsample(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
     r"""
-    Change the registration, spacing, or nodes in a grid file.
+    Resample a grid onto a new lattice.
 
     This reads a grid file and interpolates it to create a new grid
     file. It can change the registration with ``translate`` or

pygmt/src/grdtrack.py

@@ -1,5 +1,5 @@
 """
-grdtrack - Sample grids at specified (x,y) locations.
+grdtrack - Sample one or more grids at specified locations.
 """
 
 from typing import Literal
@@ -56,7 +56,7 @@ def grdtrack(
     **kwargs,
 ) -> pd.DataFrame | np.ndarray | None:
     r"""
-    Sample grids at specified (x,y) locations.
+    Sample one or more grids at specified locations.
 
     Reads one or more grid files and a table (from file or an array input; but
     see ``profile`` for exception) with (x,y) [or (lon,lat)] positions in the

pygmt/src/grdview.py

@@ -1,5 +1,5 @@
 """
-grdview - Create a three-dimensional plot from a grid.
+grdview - Create 3-D perspective image or surface mesh from a grid.
 """
 
 from pygmt.clib import Session

pygmt/src/grdvolume.py

@@ -33,7 +33,7 @@ def grdvolume(
     **kwargs,
 ) -> pd.DataFrame | np.ndarray | None:
     r"""
-    Determine the volume between the surface of a grid and a plane.
+    Calculate grid volume and area constrained by a contour.
 
     Read a 2-D grid file and calculate the volume contained below the surface
     and above the plane specified by the given contour (or zero if not given)

pygmt/src/histogram.py

@@ -1,5 +1,5 @@
 """
-Histogram - Create a histogram.
+Histogram - Calculate and plot histograms.
 """
 
 from pygmt.clib import Session
@@ -41,7 +41,7 @@
 )
 def histogram(self, data, **kwargs):
     r"""
-    Plot Cartesian histograms.
+    Calculate and plot histograms.
 
     Full option list at :gmt-docs:`histogram.html`
 

pygmt/src/image.py

@@ -1,5 +1,5 @@
 """
-image - Plot an image.
+image - Plot raster or EPS images.
 """
 
 from pygmt.clib import Session
@@ -22,7 +22,7 @@
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
 def image(self, imagefile, **kwargs):
     r"""
-    Place images or EPS files on maps.
+    Plot raster or EPS images.
 
     Reads an Encapsulated PostScript file or a raster image file and plots
     it on a map.

pygmt/src/inset.py

@@ -1,5 +1,5 @@
 """
-inset - Create inset figures.
+inset - Manage figure inset setup and completion.
 """
 
 import contextlib
@@ -24,7 +24,7 @@
 @kwargs_to_strings(D="sequence", M="sequence", R="sequence")
 def inset(self, **kwargs):
     r"""
-    Create an inset figure to be placed within a larger figure.
+    Manage figure inset setup and completion.
 
     This method sets the position, frame, and margins for a smaller figure
     inside of the larger figure. Plotting methods that are called within the

pygmt/src/legend.py

@@ -37,7 +37,7 @@ def legend(
     **kwargs,
 ):
     r"""
-    Plot legends on maps.
+    Plot a legend.
 
     Makes legends that can be overlaid on maps. Reads specific
     legend-related information from an input file, or automatically creates

pygmt/src/logo.py

@@ -1,5 +1,5 @@
 """
-logo - Plot the GMT logo
+logo - Plot the GMT logo.
 """
 
 from pygmt.clib import Session

pygmt/src/plot.py

@@ -1,5 +1,5 @@
 """
-plot - Plot in two dimensions.
+plot - Plot lines, polygons, and symbols in 2-D.
 """
 
 from typing import Literal

pygmt/src/plot3d.py

@@ -1,5 +1,5 @@
 """
-plot3d - Plot in three dimensions.
+plot3d - Plot lines, polygons, and symbols in 3-D.
 """
 
 from typing import Literal

pygmt/src/psconvert.py

@@ -1,5 +1,5 @@
 """
-psconvert - Convert [E]PS file(s) to other formats.
+psconvert - Convert [E]PS file(s) to other formats using Ghostscript.
 """
 
 from pathlib import Path
@@ -25,7 +25,7 @@
 @kwargs_to_strings()
 def psconvert(self, **kwargs):
     r"""
-    Convert [E]PS file(s) to other formats.
+    Convert [E]PS file(s) to other formats using Ghostscript.
 
     Converts one or more PostScript files to other formats (BMP, EPS, JPEG,
     PDF, PNG, PPM, TIFF) using Ghostscript.

pygmt/src/rose.py

@@ -1,5 +1,5 @@
 """
-rose - Plot windrose diagrams or polar histograms.
+rose - Plot a polar histogram (rose, sector, windrose diagrams).
 """
 
 from pygmt.clib import Session
@@ -44,7 +44,7 @@
 @kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
 def rose(self, data=None, length=None, azimuth=None, **kwargs):
     """
-    Plot windrose diagrams or polar histograms.
+    Plot a polar histogram (rose, sector, windrose diagrams).
 
     Takes a matrix, (length,azimuth) pairs, or a file name as input
     and plots windrose diagrams or polar histograms (sector diagram