Fix typos in documentations of datasets (#2688)

Co-authored-by: Michael Grund <[email protected]>

pygmt/datasets/earth_age.py

@@ -1,6 +1,6 @@
 """
-Function to download the Earth seafloor age datasets from the GMT data server,
-and load as :class:`xarray.DataArray`.
+Function to download the Earth seafloor crustal age dataset from the GMT data
+server, and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """
@@ -13,27 +13,28 @@
 @kwargs_to_strings(region="sequence")
 def load_earth_age(resolution="01d", region=None, registration=None):
     r"""
-    Load Earth seafloor crustal ages in various resolutions.
+    Load the Earth seafloor crustal age dataset in various resolutions.
 
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_age/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.
     So you'll need an internet connection the first time around.
 
     These grids can also be accessed by passing in the file name
-    **@earth_age**\_\ *res*\[_\ *reg*] to any grid plotting/processing
-    function. *res* is the grid resolution (see below), and *reg* is grid
-    registration type (**p** for pixel registration or **g** for gridline
-    registration).
+    **@earth_age**\_\ *res*\[_\ *reg*] to any grid processing function or
+    plotting method. *res* is the grid resolution (see below), and *reg* is
+    the grid registration type (**p** for pixel registration or **g** for
+    the gridline registration).
 
     The default color palette table (CPT) for this dataset is *@earth_age.cpt*.
     It's implicitly used when passing in the file name of the dataset to any
     grid plotting method if no CPT is explicitly specified. When the dataset
     is loaded and plotted as an :class:`xarray.DataArray` object, the default
-    CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
+    CPT is ignored, and GMT's default CPT (*turbo*) is used. To use the
     dataset-specific CPT, you need to explicitly set ``cmap="@earth_age.cpt"``.
 
-    Refer to :gmt-datasets:`earth-age.html` for more details.
+    Refer to :gmt-datasets:`earth-age.html` for more details about available
+    datasets, including version information and references.
 
     Parameters
     ----------

pygmt/datasets/earth_free_air_anomaly.py

@@ -1,5 +1,5 @@
 """
-Function to download the IGPP Global Earth Free-Air Anomaly datasets from the
+Function to download the IGPP Global Earth Free-Air Anomaly dataset from the
 GMT data server, and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
@@ -13,27 +13,29 @@
 @kwargs_to_strings(region="sequence")
 def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None):
     r"""
-    Load an Earth Free-Air Anomaly grid in various resolutions.
+    Load the IGPP Global Earth Free-Air Anomaly datatset in various
+    resolutions.
 
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_faa/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.
     So you'll need an internet connection the first time around.
 
     These grids can also be accessed by passing in the file name
-    **@earth_faa**\_\ *res*\[_\ *reg*] to any grid plotting/processing
-    function. *res* is the grid resolution (see below), and *reg* is grid
-    registration type (**p** for pixel registration or **g** for gridline
-    registration).
+    **@earth_faa**\_\ *res*\[_\ *reg*] to any grid processing function or
+    plotting method. *res* is the grid resolution (see below), and *reg* is
+    the grid registration type (**p** for pixel registration or **g** for
+    gridline registration).
 
     The default color palette table (CPT) for this dataset is *@earth_faa.cpt*.
     It's implicitly used when passing in the file name of the dataset to any
     grid plotting method if no CPT is explicitly specified. When the dataset
     is loaded and plotted as an :class:`xarray.DataArray` object, the default
-    CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
+    CPT is ignored, and GMT's default CPT (*turbo*) is used. To use the
     dataset-specific CPT, you need to explicitly set ``cmap="@earth_faa.cpt"``.
 
-    Refer to :gmt-datasets:`earth-faa.html` for more details.
+    Refer to :gmt-datasets:`earth-faa.html` for more details about available
+    datasets, including version information and references.
 
     Parameters
     ----------

pygmt/datasets/earth_geoid.py

@@ -1,6 +1,6 @@
 """
-Function to download the EGM2008 Global Earth Geoid from the GMT data server,
-and load as :class:`xarray.DataArray`.
+Function to download the EGM2008 Global Earth Geoid dataset from the GMT data
+server, and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """
@@ -13,20 +13,21 @@
 @kwargs_to_strings(region="sequence")
 def load_earth_geoid(resolution="01d", region=None, registration=None):
     r"""
-    Load the EGM2008 Global Earth Geoid in various resolutions.
+    Load the EGM2008 Global Earth Geoid dataset in various resolutions.
 
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_geoid/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.
     So you'll need an internet connection the first time around.
 
     These grids can also be accessed by passing in the file name
-    **@earth_geoid**\_\ *res*\[_\ *reg*] to any grid plotting/processing
-    function. *res* is the grid resolution (see below), and *reg* is grid
-    registration type (**p** for pixel registration or **g** for gridline
-    registration).
+    **@earth_geoid**\_\ *res*\[_\ *reg*] to any grid processing function or
+    plotting method. *res* is the grid resolution (see below), and *reg* is
+    the grid registration type (**p** for pixel registration or **g** for
+    gridline registration).
 
-    Refer to :gmt-datasets:`earth-geoid.html` for more details.
+    Refer to :gmt-datasets:`earth-geoid.html` for more details about available
+    datasets, including version information and references.
 
     Parameters
     ----------

pygmt/datasets/earth_magnetic_anomaly.py

@@ -16,7 +16,7 @@ def load_earth_magnetic_anomaly(
     resolution="01d", region=None, registration=None, data_source="emag2"
 ):
     r"""
-    Load an Earth magnetic anomaly grid in various resolutions.
+    Load the Earth magnetic anomaly datasets in various resolutions.
 
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_mag/``,
@@ -26,11 +26,11 @@ def load_earth_magnetic_anomaly(
     So you'll need an internet connection the first time around.
 
     These grids can also be accessed by passing in the file name
-    **@**\ *earth_mag_type*\_\ *res*\[_\ *reg*] to any grid plotting/processing
-    function. *earth_mag_type* is the GMT name
+    **@**\ *earth_mag_type*\_\ *res*\[_\ *reg*] to any grid processing
+    function or plotting method. *earth_mag_type* is the GMT name
     for the dataset. The available options are **earth_mag**,
     **earth_mag4km**, and **earth_wdmam**. *res* is the grid resolution
-    (see below), and *reg* is grid registration type (**p** for pixel
+    (see below), and *reg* is the grid registration type (**p** for pixel
     registration or **g** for gridline registration).
 
     The default color palette tables (CPTs) for this dataset are
@@ -39,12 +39,13 @@ def load_earth_magnetic_anomaly(
     ``data_source="wdmam"``. The dataset-specific CPT is implicitly used when
     passing in the file name of the dataset to any grid plotting method if no
     CPT is explicitly specified. When the dataset is loaded and plotted as an
-    :class:`xarray.DataArray` object, the default CPT is ignored and GMT's
+    :class:`xarray.DataArray` object, the default CPT is ignored, and GMT's
     default CPT (*turbo*) is used. To use the dataset-specific CPT, you need to
     explicitly set ``cmap="@earth_mag.cpt"`` or ``cmap="@earth_wdmam.cpt"``.
 
     Refer to :gmt-datasets:`earth-mag.html`
-    and :gmt-datasets:`earth-wdmam.html` for more details.
+    and :gmt-datasets:`earth-wdmam.html` for more details about available
+    datasets, including version information and references.
 
     Parameters
     ----------

pygmt/datasets/earth_mask.py

@@ -1,6 +1,6 @@
 """
-Function to download the GSHHG Global Earth Mask from the GMT data server, and
-load as :class:`xarray.DataArray`.
+Function to download the GSHHG Global Earth Mask dataset from the GMT data
+server, and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """
@@ -13,20 +13,21 @@
 @kwargs_to_strings(region="sequence")
 def load_earth_mask(resolution="01d", region=None, registration=None):
     r"""
-    Load the GSHHG Global Earth Mask in various resolutions.
+    Load the GSHHG Global Earth Mask dataset in various resolutions.
 
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_mask/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.
     So you'll need an internet connection the first time around.
 
     These grids can also be accessed by passing in the file name
-    **@earth_mask**\_\ *res*\[_\ *reg*] to any grid plotting/processing
-    function. *res* is the grid resolution (see below), and *reg* is grid
-    registration type (**p** for pixel registration or **g** for gridline
-    registration).
+    **@earth_mask**\_\ *res*\[_\ *reg*] to any grid processing function or
+    plotting method. *res* is the grid resolution (see below), and *reg* is
+    the grid registration type (**p** for pixel registration or **g** for
+    gridline registration).
 
-    Refer to :gmt-datasets:`earth-mask.html` for more details.
+    Refer to :gmt-datasets:`earth-mask.html` for more details about available
+    datasets, including version information and references.
 
     Parameters
     ----------

pygmt/datasets/earth_relief.py

@@ -20,7 +20,8 @@ def load_earth_relief(
     use_srtm=False,
 ):
     r"""
-    Load Earth relief grids (topography and bathymetry) in various resolutions.
+    Load the Earth relief datasets (topography and bathymetry) in various
+    resolutions.
 
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_relief``,
@@ -31,17 +32,17 @@ def load_earth_relief(
 
     This module downloads the grids that can also be accessed by
     passing in the file name **@**\ *earth_relief_type*\_\ *res*\[_\ *reg*] to
-    any grid plotting/processing function. *earth_relief_type* is the GMT name
-    for the dataset. The available options are **earth_relief**\,
+    any grid processing function or plotting method. *earth_relief_type* is
+    the GMT name for the dataset. The available options are **earth_relief**\,
     **earth_gebco**\, **earth_gebcosi**\, and **earth_synbath**\. *res* is the
-    grid resolution (see below), and *reg* is grid registration type
+    grid resolution (see below), and *reg* is the grid registration type
     (**p** for pixel registration or **g** for gridline registration).
 
     The default color palette table (CPT) for this dataset is *geo*.
     It's implicitly used when passing in the file name of the dataset to any
     grid plotting method if no CPT is explicitly specified. When the dataset
     is loaded and plotted as an :class:`xarray.DataArray` object, the default
-    CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
+    CPT is ignored, and GMT's default CPT (*turbo*) is used. To use the
     dataset-specific CPT, you need to explicitly set ``cmap="geo"``.
 
     Refer to :gmt-datasets:`earth-relief.html` for more details about available

pygmt/datasets/earth_vertical_gravity_gradient.py

@@ -1,6 +1,6 @@
 """
-Function to download the IGPP Global Earth Vertical Gravity Gradient from the
-GMT data server, and load as :class:`xarray.DataArray`.
+Function to download the IGPP Global Earth Vertical Gravity Gradient dataset
+from the GMT data server, and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
 """
@@ -15,7 +15,7 @@ def load_earth_vertical_gravity_gradient(
     resolution="01d", region=None, registration=None
 ):
     r"""
-    Load the IGPP Global Earth Vertical Gravity Gradient in various
+    Load the IGPP Global Earth Vertical Gravity Gradient dataset in various
     resolutions.
 
     The grids are downloaded to a user data directory
@@ -24,19 +24,20 @@ def load_earth_vertical_gravity_gradient(
     So you'll need an internet connection the first time around.
 
     These grids can also be accessed by passing in the file name
-    **@earth_vgg**\_\ *res*\[_\ *reg*] to any grid plotting/processing
-    function. *res* is the grid resolution (see below), and *reg* is grid
-    registration type (**p** for pixel registration or **g** for gridline
-    registration).
+    **@earth_vgg**\_\ *res*\[_\ *reg*] to any grid processing function or
+    plotting method. *res* is the grid resolution (see below), and *reg* is
+    the grid registration type (**p** for pixel registration or **g** for
+    gridline registration).
 
     The default color palette table (CPT) for this dataset is *@earth_vgg.cpt*.
     It's implicitly used when passing in the file name of the dataset to any
     grid plotting method if no CPT is explicitly specified. When the dataset
     is loaded and plotted as an :class:`xarray.DataArray` object, the default
-    CPT is ignored and GMT's default CPT (*turbo*) is used. To use the
+    CPT is ignored, and GMT's default CPT (*turbo*) is used. To use the
     dataset-specific CPT, you need to explicitly set ``cmap="@earth_vgg.cpt"``.
 
-    Refer to :gmt-datasets:`earth-vgg.html` for more details.
+    Refer to :gmt-datasets:`earth-vgg.html` for more details about available
+    datasets, including version information and references.
 
     Parameters
     ----------