Changeset 3103

Timestamp:

Oct 15, 2010 12:26:20 AM (11 years ago)

Author:

wehart

Message:

Adding documentation.

File:

• coopr.pyomo/trunk/coopr/pyomo/base/numvalue.py (modified) (1 diff)

coopr.pyomo/trunk/coopr/pyomo/base/numvalue.py

@@ -34 +34 @@
 def value(obj):
     """
-    A utility function that returns the value of an expression
-        # NOTE: This is a terminal class, so no need to pop the keyword/argument
-        #       I would actually argue that we just need to make the inputs named
-        #       keywords, to by-pass all of this overhead.    """
+    A utility function that returns the value of a Pyomo object or expression.
+
+    If the argument is None, a numeric value or a string, then this function simply
+    returns the argument.  Otherwise, if the argument is a NumericValue then the
+    __call__ method is executed.
+    """
     if obj is None:
         return None