[GRASS-SVN] r67570 - grass/trunk/lib/python/pygrass

[svn_grass at osgeo.org]

Author: martinl
Date: 2016-01-12 10:13:41 -0800 (Tue, 12 Jan 2016)
New Revision: 67570

Modified:
   grass/trunk/lib/python/pygrass/utils.py
Log:
pygrass: introduce minimalistic documentation of set_path()

Modified: grass/trunk/lib/python/pygrass/utils.py
===================================================================
--- grass/trunk/lib/python/pygrass/utils.py	2016-01-12 16:59:55 UTC (rev 67569)
+++ grass/trunk/lib/python/pygrass/utils.py	2016-01-12 18:13:41 UTC (rev 67570)
@@ -313,11 +313,14 @@
 
 
 def set_path(modulename, dirname=None, path='.'):
-    """Set sys.path looking in the the local directory GRASS directories."""
+    """Set sys.path looking in the the local directory GRASS directories.
+
+    @param modulename
+    @param dirname
+    @param path used to run the code locally without compilation
+    """
     import sys
     # TODO: why dirname is checked first - the logic should be revised
-    # TODO  probably also 'path' should be also removed - it's used only by
-    #       compilation process for addons (see r.green for details)
     pathlib = None
     if dirname:
         pathlib = os.path.join(path, dirname)