8000 Improve docstrings of magnetic field functions for prisms · Issue #99 · fatiando/choclo · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000
Improve docstrings of magnetic field functions for prisms #99
Open
@santisoler

Description

@santisoler

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0