From eba51bf3b70399e6a67c91af34dbb8a7a1af59e0 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2024 13:51:06 -0700 Subject: [PATCH 1/3] Fix style for density argument in prism functions --- choclo/prism/_gravity.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/choclo/prism/_gravity.py b/choclo/prism/_gravity.py index 241fac48..d03840ed 100644 --- a/choclo/prism/_gravity.py +++ b/choclo/prism/_gravity.py @@ -72,7 +72,7 @@ def gravity_pot( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -218,7 +218,7 @@ def gravity_e( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -365,7 +365,7 @@ def gravity_n( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -512,7 +512,7 @@ def gravity_u( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -665,7 +665,7 @@ def gravity_ee( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -836,7 +836,7 @@ def gravity_nn( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -1007,7 +1007,7 @@ def gravity_uu( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -1178,7 +1178,7 @@ def gravity_en( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -1325,7 +1325,7 @@ def gravity_eu( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns @@ -1473,7 +1473,7 @@ def gravity_nu( The bottom boundary of the prism. Must be in meters. prism_top : float The top boundary of the prism. Must be in meters. - density: float + density : float Density of the rectangular prism in kilograms per cubic meter. Returns From 7a08da2548f700adfba9aec895a5657f34812d46 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2024 13:53:23 -0700 Subject: [PATCH 2/3] Capitalize See Also sections in prism functions --- choclo/prism/_magnetic.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/choclo/prism/_magnetic.py b/choclo/prism/_magnetic.py index 7a946db9..b35615e1 100644 --- a/choclo/prism/_magnetic.py +++ b/choclo/prism/_magnetic.py @@ -214,7 +214,7 @@ def magnetic_field( - [Nagy2002]_ - [Fukushima2020]_ - See also + See Also -------- :func:`choclo.prism.magnetic_e` :func:`choclo.prism.magnetic_n` @@ -462,7 +462,7 @@ def magnetic_e( - [Nagy2002]_ - [Fukushima2020]_ - See also + See Also -------- :func:`choclo.prism.magnetic_field` :func:`choclo.prism.magnetic_n` @@ -663,7 +663,7 @@ def magnetic_n( - [Nagy2002]_ - [Fukushima2020]_ - See also + See Also -------- :func:`choclo.prism.magnetic_field` :func:`choclo.prism.magnetic_e` @@ -864,7 +864,7 @@ def magnetic_u( - [Nagy2002]_ - [Fukushima2020]_ - See also + See Also -------- :func:`choclo.prism.magnetic_field` :func:`choclo.prism.magnetic_e` From dd4d661dbdc55c35632edc49ec02c925cbaf73e0 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 21 May 2024 14:00:55 -0700 Subject: [PATCH 3/3] Remove double empty lines in docstrings --- choclo/prism/_kernels.py | 1 - choclo/prism/_magnetic.py | 1 - 2 files changed, 2 deletions(-) diff --git a/choclo/prism/_kernels.py b/choclo/prism/_kernels.py index 94032f1b..9646c72e 100644 --- a/choclo/prism/_kernels.py +++ b/choclo/prism/_kernels.py @@ -366,7 +366,6 @@ def kernel_u(easting, northing, upward, radius): by [Nagy2000]_ in order to compute the numerical kernel for the **upward** component instead for the downward one. - References ---------- - [Nagy2000]_ diff --git a/choclo/prism/_magnetic.py b/choclo/prism/_magnetic.py index b35615e1..7431b622 100644 --- a/choclo/prism/_magnetic.py +++ b/choclo/prism/_magnetic.py @@ -205,7 +205,6 @@ def magnetic_field( \mathbf{B}(\mathbf{p}) = \frac{\mu_0}{4\pi} \mathbf{U} \cdot \mathbf{M} - References ---------- - [Blakely1995]_