celerite icon indicating copy to clipboard operation
celerite copied to clipboard

Published 20 hours ago • verified publisher icon dfm

doc: ComplexTerm skipping log_b parameter sets b=0

Open JohannesBuchner opened this issue 2 years ago • 1 comments

https://celerite.readthedocs.io/en/stable/python/kernel/#celerite.terms.ComplexTerm states: "The parameter log_b can be omitted and it will be assumed to be zero." more precisely, b=0 is assumed. https://github.com/dfm/celerite/blob/main/celerite/terms.py#L439

Suggested new wording: "The parameter log_b can be omitted, in which case b=0 will be assumed."

JohannesBuchner avatar Jun 07 '22 22:06 JohannesBuchner

Absolutely! Would you like to submit the PR?

dfm avatar Jun 07 '22 22:06 dfm