Changeset 937 for trunk/GSASIIpy3.py

Timestamp:

May 30, 2013 4:01:11 PM (10 years ago)

Author:

toby

Message:

More improvements to ValidatedTxtCtrl?

File:

• trunk/GSASIIpy3.py (modified) (2 diffs)

trunk/GSASIIpy3.py

@@ -23 +23 @@
     be evaluated.
 
-    :param str string: Character string c
+    :param str string: Character string containing a Python expression
+      to be evaluated.
+
+    :returns: the value for the expression as a float or None if the expression does not
+      evaluate to a valid number. 
+    
     '''
     try:
@@ -33 +38 @@
 
 def FormatValue(val,maxdigits=10):
-    '''Format a float to fit in maxdigits spaces, showing as much
-    precision as possible, more or less
+    '''Format a float to fit in ``maxdigits`` spaces, showing as much
+    precision as possible, more or less.
+
+    :param float val: number to be formatted.
+
+    :param int maxdigits: the number of digits to be used for display of the
+      number (defaults to 10).
+
+    :returns: a string with <= maxdigits characters (I hope).  
     '''
     # does the standard str() conversion fit?