r10159 - /branches/multi_processor_merge/multi/uni_processor.py -- January 11, 2010 - 10:45

Author: bugman
Date: Mon Jan 11 10:45:18 2010
New Revision: 10159

URL: http://svn.gna.org/viewcvs/relax?rev=10159&view=rev
Log:
Added some docstrings.


Modified:
    branches/multi_processor_merge/multi/uni_processor.py

Modified: branches/multi_processor_merge/multi/uni_processor.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/multi_processor_merge/multi/uni_processor.py?rev=10159&r1=10158&r2=10159&view=diff
==============================================================================
--- branches/multi_processor_merge/multi/uni_processor.py (original)
+++ branches/multi_processor_merge/multi/uni_processor.py Mon Jan 11 10:45:18 
2010
@@ -85,10 +85,22 @@
 
 
     def processor_size(self):
+        """Return 1 as this is the uni-processor.
+
+        @return:    The number of processors.
+        @rtype:     int
+        """
+
         return 1
 
 
     def rank(self):
+        """The uni-processor is always of rank 0.
+
+        @return:    The processor rank.
+        @rtype:     int
+        """
+
         return 0