satellogic / orbit-predictor

Python library to propagate satellite orbits.
MIT License
140 stars 43 forks source link

PredictedPass does not clarify units of distance and time #121

Open tomaslink opened 3 years ago

tomaslink commented 3 years ago

It is desirable for users the class PredictedPass (or the whole package for that matter) to have more documentation (docstrings) about the parameters. In particular, position_ecef and velocity_ecef, we understand that they are meant to be in kilometers, but is not specified in the docstrings of the class.

https://github.com/satellogic/orbit-predictor/blob/561f432ac3679396f97ee947e549369b73456e9c/orbit_predictor/predictors/pass_iterators.py#L281