[Doc] Small improvements to YAML API docs

Cantera · Jan 21, 2020 · b7591cb · b7591cb
1 parent d5f84e9
commit b7591cb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/doc/sphinx/yaml/phases.rst b/doc/sphinx/yaml/phases.rst
@@ -326,11 +326,12 @@ properties are:
 ``electrolyte-species-type``
     One of ``solvent``, ``charged-species``, ``weak-acid-associated``,
     ``strong-acid-associated``, ``polar-neutral``, or ``nonpolar-neutral``.
-    The types ``solvent``, ``charged-species``, and ``nonpolar-neutral`` can be
-    inferred automatically.
+    The type ``solvent`` is the default for the first species in the phase. The
+    type ``charged-species`` is the default for species with a net charge.
+    Otherwise, the default is and ``nonpolar-neutral``.
 
 ``weak-acid-charge``
-    Charge to use for species can break apart into charged species.
+    Charge to use for species that can break apart into charged species.
 
 Example::
 

diff --git a/doc/sphinx/yaml/species.rst b/doc/sphinx/yaml/species.rst
@@ -22,9 +22,9 @@ The fields of a ``species`` entry are:
 ``equation-of-state``
     A mapping or list of mappings. Each mapping contains an equation of state
     model specification for the species, any parameters for that model, and any
-    parameters for interactions with other species. :ref:`sec-yaml-species-eos`.
-    If this field is absent and a model is required, the ``ideal-gas`` model is
-    assumed.
+    parameters for interactions with other species. See
+    :ref:`sec-yaml-species-eos`. If this field is absent and a model is
+    required, the ``ideal-gas`` model is assumed.
 
 ``transport``
     Mapping containing the species transport model specification and