[Doc] Fix Sphinx warnings about spacing and types

This commit is contained in:
Bryan W. Weber
2021-02-12 16:57:15 -05:00
committed by Ray Speth
parent 45c7b2bd27
commit 15806ec400
2 changed files with 8 additions and 7 deletions
-1
View File
@@ -80,7 +80,6 @@ else:
return repr(data)
def represent_float(self, data):
# type: (Any) -> Any
if data != data:
value = '.nan'
elif data == self.inf_value:
+8 -6
View File
@@ -35,13 +35,15 @@ class FlameBase(Sim1D):
The method returns simulation components that are specific to a class
derived from `FlameBase` or a specific *domain* within the `FlameBase`
simulation object. Entries may include:
* ``grid``: grid point positions along the flame [m]
* ``velocity``: normal velocity [m/s]
* ``spread_rate``: tangential velocity gradient [1/s]
* ``lambda``: radial pressure gradient [N/m^4]
* ``eField``: electric field strength
:param domain: Index of a specific domain within the `Sim1D.domains`
* ``grid``: grid point positions along the flame [m]
* ``velocity``: normal velocity [m/s]
* ``spread_rate``: tangential velocity gradient [1/s]
* ``lambda``: radial pressure gradient [N/m^4]
* ``eField``: electric field strength
:param domain:
Index of a specific domain within the `Sim1D.domains`
list. The default is to return other columns of the `Sim1D` object.
"""
if domain is None: