[GRASS-SVN] r54704 - grass-addons/grass7/raster/r.agent/libagent

[svn_grass at osgeo.org]

Author: mic
Date: 2013-01-18 14:02:02 -0800 (Fri, 18 Jan 2013)
New Revision: 54704

Modified:
   grass-addons/grass7/raster/r.agent/libagent/playground.py
Log:
improve documentation

Modified: grass-addons/grass7/raster/r.agent/libagent/playground.py
===================================================================
--- grass-addons/grass7/raster/r.agent/libagent/playground.py	2013-01-18 19:49:00 UTC (rev 54703)
+++ grass-addons/grass7/raster/r.agent/libagent/playground.py	2013-01-18 22:02:02 UTC (rev 54704)
@@ -12,10 +12,13 @@
 import numpy, error
 
 class Playground(object):
-    """A Playground is a major component of a World, defining
-       and organizing space."""
+    """
+    A Playground is a major component of a World, defining
+    and organizing space.
+    """
 
     def __init__(self):
+        """Create a Playground"""
         self.layers = dict()
 #TODO
         self.region = dict(n=1,s=0,w=0,e=1,rows=1,cols=1)
@@ -52,8 +55,8 @@
         """
         Create a new layer and add it to the layer collection
         @param string name of the layer
-        @param string file name if it is to be created from an existing file
-        @param boolean whether to overwrite an existing layer
+        @param string optional name, whether to create it from an existing file
+        @param boolean optional, whether to overwrite an existing layer
         """
         r = self.region["rows"]
         c = self.region["cols"]
@@ -89,7 +92,7 @@
         Write out a given layer to a certain file
         @param string name of the layer to be exported
         @param string name of the file to be written to
-        @param boolean whether an existing file may be overwritten
+        @param boolean optional, whether an existing file may be overwritten
         """
         #TODO export to file
         #TODO overwrite policy: to increment or to fail?