-
Notifications
You must be signed in to change notification settings - Fork 6
Description
Abstract
Some MATLAB docstrings are missing from the documentation, and others are not always updated to the current behavior.
(e.g., base classes Edit: Partially addressed in Cantera/cantera#2048).ct.ThermoPhase, ct.Kinetics and ct.Transport cannot be instantiated by themselves as they are abstract; the docstrings imply otherwise, and the id will be extremely obscure/confusing to users who are not familiar with the underlying CLib implementation
Motivation
Describe the need for the proposed change:
- What problem is it trying to solve? ... improve documentation
- Who is affected by the change? ... MATLAB users
- Why is this a good solution? ... provide accurate documentation
Possible Solutions
Writing the MATLAB docstrings by hand is tedious. Preferably, a resolution should build on #242 while ensuring that the underlying C++ docstrings are adequate. Specific sections that cannot be automated will require manual editing of docstrings.