Documentation updates #1572
Merged
Documentation updates #1572
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
Sphinx 3.x isn't compatible with our Nikola plugins, and the old extension compatibility issues with 4.x no longer hold. Sphinx 5.1.1 seems to be the most recent version that doesn't have formatting issues for us. Resolves Cantera/enhancements#175
These options generate warnings with Doxygen 1.9.6
No need to link directly to the "details" section since that now appears close to the top of the page.
Extract content from "thermoprops.dox" to populate the docstring for the ThermoPhase class and the "thermoprops" group. Fix numerous areas where this documentation was outdated or incorrect.
The classes derived from this (RedlichKwongMFTP and PengRobinson) have adequate tests.
Always write \log_{10} in the rare instances where that's what's
actually meant.
Codecov Report
@@ Coverage Diff @@
## main #1572 +/- ##
==========================================
- Coverage 70.54% 70.49% -0.05%
==========================================
Files 379 379
Lines 59110 59110
Branches 21232 21232
==========================================
- Hits 41698 41671 -27
- Misses 14338 14363 +25
- Partials 3074 3076 +2
... and 5 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ischoegl
reviewed
Aug 7, 2023
ischoegl
approved these changes
Aug 7, 2023
This was referenced Aug 9, 2023
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.
Changes proposed in this pull request
ThermoPhasedocumentation and eliminate the separate, outdatedthermoprops.doxfile\logthat should be\ln, and always write\log_{10}when we mean the base 10 log.If applicable, fill in the issue number this pull request is fixing
Closes #Cantera/enhancements#175
Checklist
scons build&scons test) and unit tests address code coverage