Minor improvements to the docs

doc/api/index.rst

@@ -17,8 +17,8 @@ Gravity Corrections
 
 For the Normal Earth correction, see package :mod:`boule`.
 
-Equivalent Layers
---------------------------
+Equivalent Sources
+------------------
 
 .. autosummary::
     :toctree: generated/

harmonica/equivalent_sources/cartesian.py

@@ -137,7 +137,7 @@ class EquivalentSources(vdb.BaseGridder):
     region_ : tuple
         The boundaries (``[W, E, S, N]``) of the data used to fit the
         interpolator. Used as the default region for the
-        :meth:`~harmonica.EQLHarmonic.grid` method.
+        :meth:`~harmonica.EquivalentSources.grid` method.
 
     References
     ----------
@@ -193,7 +193,7 @@ def fit(self, coordinates, data, weights=None):
         Fit the coefficients of the equivalent sources.
 
         The data region is captured and used as default for the
-        :meth:`~harmonica.EQLHarmonic.grid` method.
+        :meth:`~harmonica.EquivalentSources.grid` method.
 
         All input arrays must have the same shape.
 
@@ -301,7 +301,8 @@ def predict(self, coordinates):
         """
         Evaluate the estimated equivalent sources on the given set of points.
 
-        Requires a fitted estimator (see :meth:`~harmonica.EQLHarmonic.fit`).
+        Requires a fitted estimator (see
+        :meth:`~harmonica.EquivalentSources.fit`).
 
         Parameters
         ----------

harmonica/equivalent_sources/spherical.py

@@ -98,7 +98,7 @@ class EquivalentSourcesSph(vdb.BaseGridder):
     region_ : tuple
         The boundaries (``[W, E, S, N]``) of the data used to fit the
         interpolator. Used as the default region for the
-        :meth:`~harmonica.EQLHarmonicSph.grid` method.
+        :meth:`~harmonica.EquivalentSources.grid` method.
     """
 
     # Set the default dimension names for generated outputs
@@ -131,7 +131,7 @@ def fit(self, coordinates, data, weights=None):
         Fit the coefficients of the equivalent sources.
 
         The data region is captured and used as default for the
-        :meth:`~harmonica.EQLHarmonicSpherical.grid` method.
+        :meth:`~harmonica.EquivalentSourcesSph.grid` method.
 
         All input arrays must have the same shape.
 
@@ -174,7 +174,7 @@ def predict(self, coordinates):
         Evaluate the estimated equivalent sources on the given set of points.
 
         Requires a fitted estimator
-        (see :meth:`~harmonica.EQLHarmonicSpherical.fit`).
+        (see :meth:`~harmonica.EquivalentSourcesSph.fit`).
 
         Parameters
         ----------

harmonica/forward/prism_layer.py

@@ -35,7 +35,7 @@ def prism_layer(
     The ``prism_layer`` dataset accessor can be used to access special methods
     and attributes for the layer of prisms, like the horizontal dimensions of
     the prisms, getting the boundaries of each prisms, etc.
-    See :class:`XarrayAcessorPrismLayer` for the definition of these methods
+    See :class:`DatasetAccessorPrismLayer` for the definition of these methods
     and attributes.
 
     Parameters
@@ -44,7 +44,7 @@ def prism_layer(
         List containing the coordinates of the centers of the prisms in the
         following order: ``easting``, ``northing``. The arrays must be 1d
         arrays containing the coordiantes of the centers per axis, or could be
-        2d arrays as the ones returned by :func:``numpy.meshgrid``. All
+        2d arrays as the ones returned by :func:`numpy.meshgrid`. All
         coordinates should be in meters and should define a regular grid.
     surface : 2d-array
         Array used to create the uppermost boundary of the prisms layer. All

harmonica/synthetic/surveys.py

@@ -19,7 +19,7 @@ def airborne_survey(region=None, data_region=(-5.0, -4.0, 56.0, 56.5)):
 
     The observation points are sampled from the Great Britain total-field
     magnetic anomaly dataset (see
-    :func:`harmonica.datasets.fetch_britain_magnetic`). A portion of the
+    :func:`~harmonica.datasets.fetch_britain_magnetic`). A portion of the
     original survey is cut (*data_region*) and the coordinates may be scaled to
     the given *region*.
 
@@ -49,8 +49,7 @@ def airborne_survey(region=None, data_region=(-5.0, -4.0, 56.0, 56.5)):
 
     See also
     --------
-    datasets.fetch_britain_magnetic:
-        Fetch total-field magnetic anomaly data of Great Britain.
+    harmonica.datasets.fetch_britain_magnetic
     """
     # Sanity checks for region and data_region
     if region is not None:
@@ -73,9 +72,9 @@ def ground_survey(region=None, data_region=(13.60, 20.30, -24.20, -17.5)):
     Create measurement locations for a synthetic ground survey
 
     The observation points are sampled from the South Africa gravity dataset
-    (see :func:`harmonica.datasets.fetch_south_africa_gravity`). Only a portion
-    of the original survey is sampled and its region may be scaled to the
-    passed ``region``.
+    (see :func:`~harmonica.datasets.fetch_south_africa_gravity`). Only
+    a portion of the original survey is sampled and its region may be scaled to
+    the passed ``region``.
 
     Parameters
     ----------
@@ -102,7 +101,7 @@ def ground_survey(region=None, data_region=(13.60, 20.30, -24.20, -17.5)):
 
     See also
     --------
-    datasets.fetch_south_africa_gravity
+    harmonica.datasets.fetch_south_africa_gravity
     """
     # Sanity checks for region and data_region
     if region is not None: