Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix style errors in docstrings #85

Merged
merged 3 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions choclo/prism/_gravity.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion choclo/prism/_kernels.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]_
Expand Down
9 changes: 4 additions & 5 deletions choclo/prism/_magnetic.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,6 @@ def magnetic_field(

\mathbf{B}(\mathbf{p}) = \frac{\mu_0}{4\pi} \mathbf{U} \cdot \mathbf{M}


References
----------
- [Blakely1995]_
Expand All @@ -214,7 +213,7 @@ def magnetic_field(
- [Nagy2002]_
- [Fukushima2020]_

See also
See Also
--------
:func:`choclo.prism.magnetic_e`
:func:`choclo.prism.magnetic_n`
Expand Down Expand Up @@ -462,7 +461,7 @@ def magnetic_e(
- [Nagy2002]_
- [Fukushima2020]_

See also
See Also
--------
:func:`choclo.prism.magnetic_field`
:func:`choclo.prism.magnetic_n`
Expand Down Expand Up @@ -663,7 +662,7 @@ def magnetic_n(
- [Nagy2002]_
- [Fukushima2020]_

See also
See Also
--------
:func:`choclo.prism.magnetic_field`
:func:`choclo.prism.magnetic_e`
Expand Down Expand Up @@ -864,7 +863,7 @@ def magnetic_u(
- [Nagy2002]_
- [Fukushima2020]_

See also
See Also
--------
:func:`choclo.prism.magnetic_field`
:func:`choclo.prism.magnetic_e`
Expand Down
Loading