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

Improve docstrings of magnetic field functions for prisms #99

Open
santisoler opened this issue Oct 2, 2024 · 0 comments
Open

Improve docstrings of magnetic field functions for prisms #99

santisoler opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@santisoler
Copy link
Member

santisoler commented Oct 2, 2024

Page that contains the error or needs to be improved (paste link): https://www.fatiando.org/choclo/v0.2.0/api/generated/choclo.prism.magnetic_e.html#choclo.prism.magnetic_e

Description of the problem/suggestion:

I would remove the mathematical form of the kernels and point users to the docstrings of the actual kernel functions being used. Those simple mathematical forms are fine to have an understanding of the problem, but the kernels we use are more complex than that, since we are also considering limit cases and techniques to reduce floating point errors.

@santisoler santisoler added the documentation Improvements or additions to documentation label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant