Group similar parameters in docstrings (#105)

Group similar parameters together in the docstrings of forward and kernel functions for points, dipoles and prisms. This makes the docstrings of the functions shorter and avoid too many repetitions. Configure flake8 for maximum line length in docstrings to 88.
fatiando · Nov 14, 2024 · f405e25 · f405e25
1 parent 1392845
commit f405e25
Show file tree

Hide file tree

Showing 9 changed files with 355 additions and 1,085 deletions.
diff --git a/.flake8 b/.flake8
@@ -2,7 +2,7 @@
 
 [flake8]
 max-line-length = 88
-max-doc-length = 79
+max-doc-length = 88
 ignore =
     # Too many leading '#' for block comment
     E266,

diff --git a/choclo/dipole/_forward.py b/choclo/dipole/_forward.py
@@ -37,39 +37,20 @@ def magnetic_field(
 
     Parameters
     ----------
-    easting_p : float
-        Easting coordinate of the observation point in meters.
-    northing_p : float
-        Northing coordinate of the observation point in meters.
-    upward_p : float
-        Upward coordinate of the observation point in meters.
-    easting_q : float
-        Easting coordinate of the dipole in meters.
-    northing_q : float
-        Northing coordinate of the dipole in meters.
-    upward_q : float
-        Upward coordinate of the dipole in meters.
-    magnetic_moment_east : float
-        The East component of the magnetic moment vector of the dipole. Must be
-        in :math:`A m^2`.
-    magnetic_moment_north : float
-        The North component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
-    magnetic_moment_up : float
-        The upward component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
+    easting_p, northing_p, upward_p : float
+        Easting, northing and upward coordinates of the observation point in
+        meters.
+    easting_q, northing_q, upward_q : float
+        Easting, northing and upward coordinates of the dipole in meters.
+    magnetic_moment_east, magnetic_moment_north, magnetic_moment_up : float
+        The east, north and upward component of the magnetic moment vector of
+        the dipole. Must be in :math:`A m^2`.
 
     Returns
     -------
-    b_e : float
-        Easting component of the magnetic field generated by the dipole
-        on the observation point in :math:`\text{T}`.
-    b_n : float
-        Northing component of the magnetic field generated by the dipole
-        on the observation point in :math:`\text{T}`.
-    b_u : float
-        Upward component of the magnetic field generated by the dipole
-        on the observation point in :math:`\text{T}`.
+    b_e, b_n, b_u : float
+        Easting, northing and upward components of the magnetic field generated
+        by the dipole on the observation point in :math:`\text{T}`.
 
     Notes
     -----
@@ -141,27 +122,14 @@ def magnetic_e(
 
     Parameters
     ----------
-    easting_p : float
-        Easting coordinate of the observation point in meters.
-    northing_p : float
-        Northing coordinate of the observation point in meters.
-    upward_p : float
-        Upward coordinate of the observation point in meters.
-    easting_q : float
-        Easting coordinate of the dipole in meters.
-    northing_q : float
-        Northing coordinate of the dipole in meters.
-    upward_q : float
-        Upward coordinate of the dipole in meters.
-    magnetic_moment_east : float
-        The East component of the magnetic moment vector of the dipole. Must be
-        in :math:`A m^2`.
-    magnetic_moment_north : float
-        The North component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
-    magnetic_moment_up : float
-        The upward component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
+    easting_p, northing_p, upward_p : float
+        Easting, northing and upward coordinates of the observation point in
+        meters.
+    easting_q, northing_q, upward_q : float
+        Easting, northing and upward coordinates of the dipole in meters.
+    magnetic_moment_east, magnetic_moment_north, magnetic_moment_up : float
+        The east, north and upward component of the magnetic moment vector of
+        the dipole. Must be in :math:`A m^2`.
 
     Returns
     -------
@@ -232,27 +200,14 @@ def magnetic_n(
 
     Parameters
     ----------
-    easting_p : float
-        Easting coordinate of the observation point in meters.
-    northing_p : float
-        Northing coordinate of the observation point in meters.
-    upward_p : float
-        Upward coordinate of the observation point in meters.
-    easting_q : float
-        Easting coordinate of the dipole in meters.
-    northing_q : float
-        Northing coordinate of the dipole in meters.
-    upward_q : float
-        Upward coordinate of the dipole in meters.
-    magnetic_moment_east : float
-        The East component of the magnetic moment vector of the dipole. Must be
-        in :math:`A m^2`.
-    magnetic_moment_north : float
-        The North component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
-    magnetic_moment_up : float
-        The upward component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
+    easting_p, northing_p, upward_p : float
+        Easting, northing and upward coordinates of the observation point in
+        meters.
+    easting_q, northing_q, upward_q : float
+        Easting, northing and upward coordinates of the dipole in meters.
+    magnetic_moment_east, magnetic_moment_north, magnetic_moment_up : float
+        The east, north and upward component of the magnetic moment vector of
+        the dipole. Must be in :math:`A m^2`.
 
     Returns
     -------
@@ -323,27 +278,14 @@ def magnetic_u(
 
     Parameters
     ----------
-    easting_p : float
-        Easting coordinate of the observation point in meters.
-    northing_p : float
-        Northing coordinate of the observation point in meters.
-    upward_p : float
-        Upward coordinate of the observation point in meters.
-    easting_q : float
-        Easting coordinate of the dipole in meters.
-    northing_q : float
-        Northing coordinate of the dipole in meters.
-    upward_q : float
-        Upward coordinate of the dipole in meters.
-    magnetic_moment_east : float
-        The East component of the magnetic moment vector of the dipole. Must be
-        in :math:`A m^2`.
-    magnetic_moment_north : float
-        The North component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
-    magnetic_moment_up : float
-        The upward component of the magnetic moment vector of the dipole. Must
-        be in :math:`A m^2`.
+    easting_p, northing_p, upward_p : float
+        Easting, northing and upward coordinates of the observation point in
+        meters.
+    easting_q, northing_q, upward_q : float
+        Easting, northing and upward coordinates of the dipole in meters.
+    magnetic_moment_east, magnetic_moment_north, magnetic_moment_up : float
+        The east, north and upward component of the magnetic moment vector of
+        the dipole. Must be in :math:`A m^2`.
 
     Returns
     -------