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

[Bug]: Documentation is for old release <3.0 (e.g. Ellipsoid) #80

Open
ghost opened this issue Mar 2, 2023 · 0 comments
Open

[Bug]: Documentation is for old release <3.0 (e.g. Ellipsoid) #80

ghost opened this issue Mar 2, 2023 · 0 comments
Labels

Comments

@ghost
Copy link

ghost commented Mar 2, 2023

What happened?

I followed the link to the API docs from the github project page. The documentation is out of date and still applies to a pre-3.0.0 version. For example, the new code and interface for Ellipsoid is here and has parameters like this:

        Parameters
        ----------
        semimajor_axis : float
            semimajor axis in meters
        semiminor_axis : float
            semiminor axis in meters
        name: str, optional
            Human-friendly name for the ellipsoid
        model: str, optional
            Short name for the ellipsoid
        """

but the official docs on https://geospace-code.github.io/pymap3d/ellipsoid.html have the old interface, with only a string parameter:

class Ellipsoid(model='wgs84')

and

        Parameters
        ----------
        model : str
                name of ellipsoid

Can you update the official docs for the new interface (3.0.0) please?

Relevant log output

No response

@ghost ghost added the bug label Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

0 participants