r15183 - /branches/spec_api/specific_fns/api_common.py -- January 19, 2012 - 09:30

Author: bugman
Date: Thu Jan 19 09:30:22 2012
New Revision: 15183

URL: http://svn.gna.org/viewcvs/relax?rev=15183&view=rev
Log:
Created the specific function API common method _return_data_desc_spin().


Modified:
    branches/spec_api/specific_fns/api_common.py

Modified: branches/spec_api/specific_fns/api_common.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/spec_api/specific_fns/api_common.py?rev=15183&r1=15182&r2=15183&view=diff
==============================================================================
--- branches/spec_api/specific_fns/api_common.py (original)
+++ branches/spec_api/specific_fns/api_common.py Thu Jan 19 09:30:22 2012
@@ -227,6 +227,19 @@
         return 1.0
 
 
+    def _return_data_desc_spin(self, name):
+        """Return a description of the spin parameter.
+
+        @param name:    The name of the spin specific object.
+        @type name:     str
+        @return:        The object description, or None.
+        @rtype:         str or None
+        """
+
+        # Return the name.
+        return self.SPIN_PARAMS.get_desc(name)
+
+
     def _return_data_name(self, param):
         """Return a unique identifying string for the global or spin 
parameter.