r15415 - /1.3/multi/api.py -- March 01, 2012 - 10:10

Author: bugman
Date: Thu Mar  1 10:10:36 2012
New Revision: 15415

URL: http://svn.gna.org/viewcvs/relax?rev=15415&view=rev
Log:
Updated the Slave_command.run() docstring to state that this must be 
overridden.


Modified:
    1.3/multi/api.py

Modified: 1.3/multi/api.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/multi/api.py?rev=15415&r1=15414&r2=15415&view=diff
==============================================================================
--- 1.3/multi/api.py (original)
+++ 1.3/multi/api.py Thu Mar  1 10:10:36 2012
@@ -268,13 +268,11 @@
 
 
     def run(self, processor, completed):
-        '''Run the slave command on the slave processor.
-
-        The run command B{must} return at least one Result_command even if 
it is a
-        processor.NULL_RESULT.  Results are returned from the Slave_command 
to the master processor
-        using the return_object method of the processor passed to the 
command. Any exceptions raised
-        will be caught wrapped and returned to the master processor by the 
slave processor.
-
+        '''Run the slave command on the slave processor
+        
+        This is a base method which must be overridden.
+
+        The run command B{must} return at least one Result_command even if 
it is a processor.NULL_RESULT.  Results are returned from the Slave_command 
to the master processor using the return_object method of the processor 
passed to the command. Any exceptions raised will be caught wrapped and 
returned to the master processor by the slave processor.
         '''
 
         # This must be overridden!