Skip to content

Commit

Permalink
Update get_light_curve docstring (#235)
Browse files Browse the repository at this point in the history
To clarify that the phrase "The radius of the transiting body in the same units as ``r_star``" does not mean "The radius of the transiting body in units of ``r_star``".
  • Loading branch information
lgbouma committed Oct 6, 2021
1 parent ec99bb5 commit 6c2fc3a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/exoplanet/light_curves/limb_dark.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ def get_light_curve(
``r_star``. This should have a shape that is consistent with
the coordinates returned by ``orbit``. In general, this means
that it should probably be a scalar or a vector with one entry
for each body in ``orbit``.
for each body in ``orbit``. Note that this is a different
quantity than the planet-to-star radius ratio; do not confuse
the two!
t (tensor): The times where the light curve should be evaluated.
texp (Optional[tensor]): The exposure time of each observation.
This can be a scalar or a tensor with the same shape as ``t``.
Expand Down

0 comments on commit 6c2fc3a

Please sign in to comment.