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.

Sign up for GitHub

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

Jump to bottom

doc: ComplexTerm skipping log_b parameter sets b=0 #182

Open

JohannesBuchner opened this issue Jun 7, 2022 · 1 comment

JohannesBuchner commented Jun 7, 2022

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 changed the title ~~doc:~~ doc: ComplexTerm skipping log_b parameter sets b=0

Owner

dfm commented Jun 7, 2022

Absolutely! Would you like to submit the PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment