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

Documentation updates #1296

Merged
merged 8 commits into from May 30, 2022
Merged

Documentation updates #1296

merged 8 commits into from May 30, 2022

Conversation

speth
Copy link
Member

@speth speth commented May 30, 2022

Changes proposed in this pull request

  • Fix usage of the @internal and @see directives in Doxygen docstrings
  • Fix a bunch of Python classes / functions that were not included in the Sphinx docs
  • Document that eV is an acceptable unit of activation energy

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

Copy link
Member

@ischoegl ischoegl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@speth ... thank you for those fixes! I just have some very minor comments.

doc/sphinx/yaml/general.rst Outdated Show resolved Hide resolved
include/cantera/base/logger.h Outdated Show resolved Hide resolved
include/cantera/kinetics/BlowersMaselRate.h Outdated Show resolved Hide resolved
src/base/application.h Outdated Show resolved Hide resolved
src/base/application.h Outdated Show resolved Hide resolved
Co-authored-by: Ingmar Schoegl <ischoegl@lsu.edu>
@codecov
Copy link

codecov bot commented May 30, 2022

Codecov Report

Merging #1296 (ee7ad1f) into main (c040b12) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1296      +/-   ##
==========================================
- Coverage   67.26%   67.18%   -0.08%     
==========================================
  Files         314      314              
  Lines       41887    41904      +17     
  Branches    16852    16863      +11     
==========================================
- Hits        28174    28155      -19     
- Misses      11483    11518      +35     
- Partials     2230     2231       +1     
Impacted Files Coverage Δ
include/cantera/base/AnyMap.h 84.37% <ø> (ø)
include/cantera/base/Units.h 70.00% <ø> (ø)
include/cantera/base/YamlWriter.h 100.00% <ø> (ø)
include/cantera/base/ctexceptions.h 56.52% <ø> (ø)
include/cantera/base/global.h 80.95% <ø> (ø)
include/cantera/base/logger.h 78.57% <ø> (ø)
include/cantera/equil/ChemEquil.h 100.00% <ø> (ø)
include/cantera/kinetics/BlowersMaselRate.h 97.67% <ø> (ø)
include/cantera/kinetics/GasKinetics.h 100.00% <ø> (ø)
include/cantera/kinetics/InterfaceRate.h 87.95% <ø> (ø)
... and 21 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

Copy link
Member

@ischoegl ischoegl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - looks good to me!

@ischoegl ischoegl merged commit 8fbb4bc into Cantera:main May 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants