r13905 - /1.3/specific_fns/api_base.py -- July 26, 2011 - 21:52

Author: bugman
Date: Tue Jul 26 21:52:58 2011
New Revision: 13905

URL: http://svn.gna.org/viewcvs/relax?rev=13905&view=rev
Log:
Modified the specific functions API method data_type() so that Python type 
objects should be returned.


Modified:
    1.3/specific_fns/api_base.py

Modified: 1.3/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/api_base.py?rev=13905&r1=13904&r2=13905&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Tue Jul 26 21:52:58 2011
@@ -150,12 +150,12 @@
 
 
     def data_type(self, param=None):
-        """Return the type of data, as a string, that the parameter should 
be.
+        """Return the type of data that the parameter should be.
 
         @keyword param:     The parameter name.
         @type param:        list of str
-        @return:            The type of the parameter, as a string.  I.e. 
'int', 'float', 'str', 'bool', 'list of str', 'dict of bool', etc.
-        @rtype:             str
+        @return:            The type of the parameter.  I.e. the special 
Python type objects of int, float, str, bool, [str], {bool}, etc.
+        @rtype:             any type
         """
 
         # Not implemented.