Fixing incorrect doc stings (#820)

IDAES · Apr 22, 2022 · 828e469 · 828e469
1 parent ebf51d2
commit 828e469
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 9 deletions.
diff --git a/idaes/core/base/control_volume0d.py b/idaes/core/base/control_volume0d.py
@@ -1167,9 +1167,9 @@ def add_total_enthalpy_balances(
                     mass transfer should be included in enthalpy balance. This
                     should generally be the same as the has_mass_transfer
                     argument in the material balance methods
-            custom_term - a Pyomo Expression representing custom terms to
-                    be included in enthalpy balances.
-                    Expression must be indexed by time and phase list
+            custom_term - a Python method which returns Pyomo expressions representing
+                    custom terms to be included in enthalpy balances.
+                    Method should accept time and phase list as arguments.
 
         Returns:
             Constraint object representing enthalpy balances
@@ -1378,9 +1378,9 @@ def add_total_pressure_balances(self, has_pressure_change=False, custom_term=Non
         Args:
             has_pressure_change - whether terms for pressure change should be
                     included in enthalpy balances
-            custom_term - a Pyomo Expression representing custom terms to
-                    be included in pressure balances.
-                    Expression must be indexed by time
+            custom_term - a Python method which returns Pyomo expressions representing
+                    custom terms to be included in enthalpy balances.
+                    Method should accept time as an arguments.
 
         Returns:
             Constraint object representing pressure balances

diff --git a/idaes/core/base/control_volume1d.py b/idaes/core/base/control_volume1d.py
@@ -1483,9 +1483,9 @@ def add_total_enthalpy_balances(
                     mass transfer should be included in enthalpy balance. This
                     should generally be the same as the has_mass_transfer
                     argument in the material balance methods
-            custom_term - a Pyomo Expression representing custom terms to
-                    be included in enthalpy balances.
-                    Expression must be indexed by time, length and phase list
+            custom_term - a Python method which returns Pyomo expressions representing
+                    custom terms to be included in enthalpy balances.
+                    Method should accept time, length and phase list as arguments.
 
         Returns:
             Constraint object representing enthalpy balances
@@ -1746,6 +1746,9 @@ def add_total_pressure_balances(self, has_pressure_change=False, custom_term=Non
             custom_term - a Pyomo Expression representing custom terms to
                     be included in pressure balances.
                     Expression must be indexed by time and length domain
+            custom_term - a Python method which returns Pyomo expressions representing
+                    custom terms to be included in enthalpy balances.
+                    Method should accept time and length as arguments.
 
         Returns:
             Constraint object representing pressure balances