Cantera / cantera

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

Add transport_model options to python module documentation #1658

Closed d-e-t closed 5 months ago

d-e-t commented 5 months ago

Problem description

The python module documentation for the transport_model method lacks reference to the model options. This documentation would be improved by adding the transport model labels, especially with the changes in label from Cantera 2.6 to 3.0. (for example from "Multi" to "multicomponent"). The Matlab documentation includes transport model options.

Cantera versions

Applies to documentation for the current stable 3.0.0 and development 3.1

ischoegl commented 5 months ago

@d-e-t ... thank you for your suggestion. Adding documentation is relatively straight-forward - in case you should be sufficiently familiar, feel free to start a PR to address this issue.

d-e-t commented 5 months ago

@ischoegl - Yes, this is pretty minor, and I think it is clearer in my edit.

d-e-t commented 5 months ago

Approved by @decaluwe -- thanks! Closing this now.