r10175 - /branches/multi_processor_merge/generic_fns/subdivide_grid.py -- January 11, 2010 - 18:14

Author: bugman
Date: Mon Jan 11 18:14:12 2010
New Revision: 10175

URL: http://svn.gna.org/viewcvs/relax?rev=10175&view=rev
Log:
Added a docstring to the __iter__() method.


Modified:
    branches/multi_processor_merge/generic_fns/subdivide_grid.py

Modified: branches/multi_processor_merge/generic_fns/subdivide_grid.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/multi_processor_merge/generic_fns/subdivide_grid.py?rev=10175&r1=10174&r2=10175&view=diff
==============================================================================
--- branches/multi_processor_merge/generic_fns/subdivide_grid.py (original)
+++ branches/multi_processor_merge/generic_fns/subdivide_grid.py Mon Jan 11 
18:14:12 2010
@@ -77,6 +77,12 @@
 
 
     def __iter__(self):
+        """Convert the class into an iterable object.
+
+        @return:    An iterator object.
+        @rtype:     Iterator instance
+        """
+
         return Iterator(self, self.start, self.start+self.range)