-
-
Notifications
You must be signed in to change notification settings - Fork 346
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.
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
[Python] Fix typos in docstrings and extend documentation #1335
Conversation
Add equations to the equivalence_ratio and mixture_fraction functions in the docstrings and fix some typos
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks for catching and tackling this, @g3bk47 ! I think most of these are straightforward. I made one suggestion to make the notation used in the explanation of the mole fractions equation match that used in the equation (which you self-correct, in the mass-fraction version).
Other than that, this looks good to go. Thanks again!
Co-authored-by: Steven C. DeCaluwe <steven.decaluwe@gmail.com>
Thanks, @decaluwe! I commited your suggestion |
Thanks, @g3bk47 - this all LGTM. I'm not sure why the CI/Coverage test is failing. Once that clears up, I'll go ahead and merge. Are you already added to |
Yes, I am already listed in the authors file (https://github.com/Cantera/cantera/blob/main/AUTHORS#L63) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On second look, I noticed that the docs are currently not building - could you please address? There are some warnings about block quotes, see https://github.com/Cantera/cantera/runs/7361821505?check_suite_focus=true
Other than that, a couple of lines go beyond our 88 character limit.
@ischoegl You are right, the comment strings need to be raw strings due to the latex syntax. I built the sphinx documentation locally and it seems to work now |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was about to merge, but found one stray quotation mark
Co-authored-by: Ingmar Schoegl <ischoegl@lsu.edu>
Good catch, thanks! |
Changes proposed in this pull request
Add equations to the equivalence_ratio and mixture_fraction functions in the python docstrings and fix some formatting typos
scons build
&scons test
) and unit tests address code coverage