Small updates for consistency

Cantera · Dec 24, 2023 · de4e7c2 · de4e7c2
1 parent 245e488
commit de4e7c2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/interfaces/cython/cantera/thermo.pyx b/interfaces/cython/cantera/thermo.pyx
@@ -303,6 +303,13 @@ cdef class ThermoPhase(_SolutionBase):
 
         >>> phase()
         >>> print(phase.report())
+
+        :param show_thermo:
+            A Boolean argument specifying whether to show phase thermodynamic
+            information in the ouptut.
+        :param threshold:
+            The threshold used to clip data in the output. Values below the threshold
+            are not displayed.
         """
         return pystr(self.thermo.report(bool(show_thermo), threshold))
 

diff --git a/site_scons/site_tools/UnitsInterfaceBuilder.py b/site_scons/site_tools/UnitsInterfaceBuilder.py
@@ -188,8 +188,9 @@ def __setattr__(self, name, value):
             else:
                 setattr(self._phase, name, value)
 
-        def report(self, show_thermo=True, threshold=1e-14):
-            return self._phase.report(bool(show_thermo), threshold)
+        @copy_doc
+        def report(self, *args, **kwargs):
+            return self._phase.report(*args, **kwargs)
 
         def __call__(self, *args, **kwargs):
             print(self.report(*args, **kwargs))