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

Use Doxygen @cite #1550

Merged
merged 8 commits into from
Jul 28, 2023
Merged

Use Doxygen @cite #1550

merged 8 commits into from
Jul 28, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jul 22, 2023

Changes proposed in this pull request

Use Doxygen @cite command to create Bibliography.

  • The PR creates links for most (?) citations referenced from C++ docstrings.
  • Presumably, 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

image

Checklist

  • 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

@ischoegl ischoegl requested a review from a team July 22, 2023 16:07
@ischoegl ischoegl marked this pull request as ready for review July 22, 2023 16:08
@codecov
Copy link

codecov bot commented Jul 22, 2023

Codecov Report

Merging #1550 (fe81b7c) into main (5f1014c) will increase coverage by 0.01%.
Report is 2 commits behind head on main.
The diff coverage is n/a.

@@            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     
Files Changed Coverage Δ
include/cantera/kinetics/BlowersMaselRate.h 97.50% <ø> (ø)
include/cantera/kinetics/Falloff.h 81.63% <ø> (ø)
include/cantera/kinetics/InterfaceRate.h 87.87% <ø> (ø)
include/cantera/kinetics/TwoTempPlasmaRate.h 100.00% <ø> (ø)
include/cantera/numerics/Func1.h 49.55% <ø> (ø)
include/cantera/oneD/Boundary1D.h 48.97% <ø> (ø)
include/cantera/oneD/Domain1D.h 79.69% <ø> (ø)
include/cantera/oneD/Sim1D.h 66.66% <ø> (ø)
include/cantera/oneD/StFlow.h 100.00% <ø> (ø)
include/cantera/thermo/PlasmaPhase.h 81.39% <ø> (ø)
... and 8 more

... and 4 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ischoegl ischoegl force-pushed the doxygen-cite branch 3 times, most recently from aba64a3 to 1e3b696 Compare July 24, 2023 00:34
@ischoegl ischoegl changed the title Use Doxygen \cite Use Doxygen @cite Jul 24, 2023
Copy link
Member

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

src/base/application.h Outdated Show resolved Hide resolved
include/cantera/transport/IonGasTransport.h Outdated Show resolved Hide resolved
@ischoegl
Copy link
Member Author

Thanks, @speth ... I believe this is taken care of.

@ischoegl ischoegl merged commit d01ce5a into Cantera:main Jul 28, 2023
40 checks passed
@ischoegl ischoegl deleted the doxygen-cite branch July 28, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants