Cantera / cantera

Chemical kinetics, thermodynamics, and transport tool suite
https://cantera.org
Other
582 stars 342 forks source link

More Sphinx / Doxygen updates #1590

Closed speth closed 10 months ago

speth commented 10 months ago

Changes proposed in this pull request

If applicable, provide an example illustrating new features this pull request is introducing

Member function with warning and versionadded directives:


image

Default view of the "Classes" page:


image


Checklist

codecov[bot] commented 10 months ago

Codecov Report

Merging #1590 (8e364b8) into main (43fca53) will increase coverage by 0.00%. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1590   +/-   ##
=======================================
  Coverage   70.60%   70.61%           
=======================================
  Files         379      379           
  Lines       59153    59153           
  Branches    21252    21252           
=======================================
+ Hits        41766    41768    +2     
+ Misses      14313    14311    -2     
  Partials     3074     3074           
Files Changed Coverage Δ
include/cantera/oneD/IonFlow.h 73.33% <ø> (ø)
include/cantera/thermo/HMWSoln.h 40.00% <ø> (ø)
include/cantera/thermo/MixtureFugacityTP.h 33.33% <ø> (ø)
include/cantera/thermo/MolalityVPSSTP.h 80.00% <ø> (ø)
include/cantera/thermo/PDSS_HKFT.h 100.00% <ø> (ø)
include/cantera/thermo/Phase.h 78.57% <ø> (ø)
include/cantera/thermo/ThermoPhase.h 47.16% <ø> (ø)
include/cantera/thermo/VPStandardStateTP.h 100.00% <ø> (ø)
include/cantera/transport/Transport.h 17.43% <ø> (ø)
interfaces/cython/cantera/kinetics.pyx 91.81% <ø> (+0.43%) :arrow_up:
... and 3 more

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

speth commented 10 months ago

Thanks for catching those inconsistencies, @ischoegl. This should be good to go now.