Skip to content
This repository has been archived by the owner on Oct 14, 2023. It is now read-only.

[doc] Misleading documentation for Orbit.from_ephem #1634

Open
ellequelle opened this issue Jul 3, 2023 · 0 comments
Open

[doc] Misleading documentation for Orbit.from_ephem #1634

ellequelle opened this issue Jul 3, 2023 · 0 comments

Comments

@ellequelle
Copy link

馃悶 Problem

Parameters in doc are in a different order from the method signature (this is nitpicky, I know, but it's different from all of the other methods in this file):

def from_ephem(cls, attractor, ephem, epoch):

Parameters
----------
ephem : ~poliastro.ephem.Ephem
Ephemerides object to use.
attractor : ~poliastro.bodies.Body
Body to use as attractor.
epoch : ~astropy.time.Time
Epoch to retrieve the osculating orbit at.

馃挕 Possible solutions
I'll submit a pull request shortly

ellequelle added a commit to ellequelle/poliastro that referenced this issue Jul 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant