r15626 - /1.3/multi/__init__.py -- March 23, 2012 - 18:52

Author: bugman
Date: Fri Mar 23 18:52:46 2012
New Revision: 15626

URL: http://svn.gna.org/viewcvs/relax?rev=15626&view=rev
Log:
Added some epydoc @attention fields to the multi-processor API.


Modified:
    1.3/multi/__init__.py

Modified: 1.3/multi/__init__.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/multi/__init__.py?rev=15626&r1=15625&r2=15626&view=diff
==============================================================================
--- 1.3/multi/__init__.py (original)
+++ 1.3/multi/__init__.py Fri Mar 23 18:52:46 2012
@@ -204,6 +204,8 @@
     This is for fetching data from the data store of the Processor instance. 
 If run on the master, then the master's data store will be accessed.  If run 
on the slave, then the slave's data store will be accessed.
 
 
+    @attention:     No inter-processor communications are performed.
+
     @keyword name:  The name of the data structure to fetch.
     @type name:     str
     @return:        The value of the associated data structure.
@@ -222,6 +224,7 @@
 
     If run on the master, then the master's data store will be returned.  If 
run on the slave, then the slave's data store will be returned.
 
+
     @attention:     No inter-processor communications are performed.
 
     @return:        The data store of the processor (of the same rank as the 
calling code).
@@ -237,6 +240,8 @@
 
 def send_data_to_slaves(name=None, value=None):
     """API function for sending data from the master to all slaves 
processors.
+
+    @attention:     Inter-processor communications are performed.
 
     @keyword name:  The name of the data structure to store.
     @type name:     str