r18819 - /trunk/specific_fns/api_base.py -- March 13, 2013 - 16:18

Author: bugman
Date: Wed Mar 13 16:18:17 2013
New Revision: 18819

URL: http://svn.gna.org/viewcvs/relax?rev=18819&view=rev
Log:
Shifted all of the documentation variables to the top of the specific 
API_base class.

This is for better organisation.


Modified:
    trunk/specific_fns/api_base.py

Modified: trunk/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/api_base.py?rev=18819&r1=18818&r2=18819&view=diff
==============================================================================
--- trunk/specific_fns/api_base.py (original)
+++ trunk/specific_fns/api_base.py Wed Mar 13 16:18:17 2013
@@ -37,6 +37,13 @@
     All the methods here are prototype methods.  To identify that the method 
is not available for certain analysis types, if called a RelaxImplementError 
is raised if called.
     """
 
+    # Empty documentation strings.
+    default_value_doc = ""
+    eliminate_doc = ""
+    return_data_name_doc = ""
+    set_doc = ""
+
+
     def __init__(self):
         """Set up the specific objects."""
 
@@ -183,8 +190,6 @@
         return self.PARAMS.get_type(param)
 
 
-    # Empty documentation string.
-    default_value_doc = ""
     def default_value(self, param):
         """Return the default parameter values.
 
@@ -233,8 +238,6 @@
         raise RelaxImplementError('duplicate_data')
 
 
-    # Empty documentation string.
-    eliminate_doc = ""
     def eliminate(self, name, value, model_info, args, sim=None):
         """Model elimination method.
 
@@ -555,8 +558,6 @@
         return self.PARAMS.get_desc(name)
 
 
-    # Empty documentation string.
-    return_data_name_doc = ""
     def return_data_name(self, param):
         """Return a unique identifying string for the given parameter.
 
@@ -638,10 +639,6 @@
         raise RelaxImplementError('return_value')
 
 
-    # Empty documentation string.
-    set_doc = ""
-
-
     def set_error(self, model_info, index, error):
         """Set the model parameter errors.