Skip to content
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

Merged
merged 4 commits into from Jul 16, 2022

Conversation

g3bk47
Copy link
Contributor

@g3bk47 g3bk47 commented Jul 13, 2022

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

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

Add equations to the equivalence_ratio and mixture_fraction functions in the docstrings and fix some typos
Copy link
Member

@decaluwe decaluwe left a 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!

interfaces/cython/cantera/thermo.pyx Outdated Show resolved Hide resolved
Co-authored-by: Steven C. DeCaluwe <steven.decaluwe@gmail.com>
@g3bk47
Copy link
Contributor Author

g3bk47 commented Jul 13, 2022

Thanks, @decaluwe! I commited your suggestion

@decaluwe
Copy link
Member

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 AUTHORS.md? I am guessing you are, but thought I'd ask.

decaluwe
decaluwe previously approved these changes Jul 15, 2022
@ischoegl
Copy link
Member

@g3bk47 and @decaluwe ... I retriggered the failing tests and they now pass - so it was just some temporary GitHub issue. Thanks for the fix!

@g3bk47
Copy link
Contributor Author

g3bk47 commented Jul 15, 2022

Yes, I am already listed in the authors file (https://github.com/Cantera/cantera/blob/main/AUTHORS#L63)

Copy link
Member

@ischoegl ischoegl left a 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.

interfaces/cython/cantera/thermo.pyx Outdated Show resolved Hide resolved
@g3bk47
Copy link
Contributor Author

g3bk47 commented Jul 16, 2022

@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

Copy link
Member

@ischoegl ischoegl left a 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

interfaces/cython/cantera/thermo.pyx Outdated Show resolved Hide resolved
Co-authored-by: Ingmar Schoegl <ischoegl@lsu.edu>
@g3bk47
Copy link
Contributor Author

g3bk47 commented Jul 16, 2022

Good catch, thanks!

@ischoegl ischoegl merged commit 3c24987 into Cantera:main Jul 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants