-
-
Notifications
You must be signed in to change notification settings - Fork 349
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
Use Doxygen @cite #1550
Use Doxygen @cite #1550
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1550 +/- ##
==========================================
+ Coverage 70.46% 70.48% +0.01%
==========================================
Files 379 379
Lines 59091 59093 +2
Branches 21228 21230 +2
==========================================
+ Hits 41641 41653 +12
+ Misses 14369 14360 -9
+ Partials 3081 3080 -1
... and 4 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
aba64a3
to
1e3b696
Compare
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.
Thanks, @ischoegl, I think is an improvement, and may encourage better habits for referencing the literature in the future. I had just a couple of comments.
Thanks, @speth ... I believe this is taken care of. |
Changes proposed in this pull request
Use Doxygen
@cite
command to create Bibliography.sphinxcontrib-bibtex
cannot be used in this context (Doxygen); the@cite
command is easy to use, and does not require the creation of separate documentation in Sphinx.See comment in Cantera/enhancements#178 (comment)
Addresses Cantera/enhancements#145 and Cantera/enhancements#179
If applicable, provide an example illustrating new features this pull request is introducing
Checklist
scons build
&scons test
) and unit tests address code coverage