Various documentation improvements#1152
Merged
ischoegl merged 8 commits intoCantera:mainfrom Dec 5, 2021
Merged
Conversation
This file is of unknown provenance, contains discontinuous thermo data, and is no longer used in any examples or tests.
The group delimeters "@{" and "@}" are only evaluated inside a Doxygen
comment, e.g. on a line starting with '//!'.
Add Doxygen docstrings for all classes reactor-related classes, including factories. Create a "module" entry within the Doxygen docs, with a link to the "Science" docs on the Cantera website.
Codecov Report
@@ Coverage Diff @@
## main #1152 +/- ##
=======================================
Coverage 73.76% 73.76%
=======================================
Files 370 370
Lines 48983 48983
=======================================
Hits 36133 36133
Misses 12850 12850
Continue to review full report at Codecov.
|
ischoegl
approved these changes
Dec 5, 2021
Member
ischoegl
left a comment
ischoegl
left a comment
There was a problem hiding this comment.
Looks good to me. Thanks for going over this!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes proposed in this pull request
newThermoPhaseregarding exceptions and return typessilane.yamlinput file@TODOcommand (only@todois recognized)Checklist
scons build&scons test) and unit tests address code coverage