Update C++ and Fortran example docstrings #983
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #983 +/- ##
==========================================
- Coverage 71.60% 71.60% -0.01%
==========================================
Files 360 360
Lines 45719 45718 -1
==========================================
- Hits 32736 32735 -1
Misses 12983 12983
Continue to review full report at Codecov.
|
Using a consistent formatting here makes it easier to automatically extract a title and summary for the example index on the Cantera website.
speth
force-pushed
the
example-docstrings
branch
from
e97db00
to
4cdf97a
Compare
12Chao
reviewed
Mar 30, 2021
jongyoonbae
reviewed
Mar 30, 2021
Comment on lines
+7
to
+8
| * equations are custom-implemented, using Cantera's interface to CVODES to | ||
| * integrate the equations. |
There was a problem hiding this comment.
"Cantera's interface to CVODES to integrate" -> Do you mean "Cantera's interface CVODES to integrate"?
There was a problem hiding this comment.
Thanks @jongyoonbae! I think this is correct as written. Cantera provides an interfaces that connects to CVODES, which is actually does the numerical integration.
jongyoonbae
reviewed
Mar 30, 2021
bryanwweber
approved these changes
Apr 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a companion to Cantera/cantera-website#136.
Changes proposed in this pull request
If applicable, fill in the issue number this pull request is fixing
Fixes #
Checklist
scons build&scons test) and unit tests address code coverage