From de4e7c2c445fb66f2d366fecf3c27a758497ed7b Mon Sep 17 00:00:00 2001 From: Bryan Weber Date: Sun, 24 Dec 2023 15:03:30 -0500 Subject: [PATCH] Small updates for consistency --- interfaces/cython/cantera/thermo.pyx | 7 +++++++ site_scons/site_tools/UnitsInterfaceBuilder.py | 5 +++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/interfaces/cython/cantera/thermo.pyx b/interfaces/cython/cantera/thermo.pyx index 928ea0e4a9..32de07cf82 100644 --- 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 index cfdaa5b418..5db6d69536 100644 --- 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))