[GRASS-SVN] r62788 - in grass/branches/releasebranch_7_0: . lib/python/script

[svn_grass at osgeo.org]

Author: wenzeslaus
Date: 2014-11-17 18:40:19 -0800 (Mon, 17 Nov 2014)
New Revision: 62788

Modified:
   grass/branches/releasebranch_7_0/
   grass/branches/releasebranch_7_0/lib/python/script/core.py
Log:
pythonlib: describe more error and fatal functions (backport r62709)


Property changes on: grass/branches/releasebranch_7_0
___________________________________________________________________
Modified: svn:mergeinfo
   - /grass/trunk:60817,61096,61141,62179-62180,62182,62403,62422,62424,62437,62466,62469,62487,62491,62494,62501,62506,62508-62509,62515,62518-62519,62521,62526,62533,62539,62541,62555,62562,62566,62570,62573,62575,62585,62588,62597,62603,62606,62608-62609,62614,62618,62628,62632,62638,62642,62648-62649,62652,62654-62657,62666,62705,62723,62730,62739,62741,62743,62746,62750,62752,62757,62762
   + /grass/trunk:60817,61096,61141,62179-62180,62182,62403,62422,62424,62437,62466,62469,62487,62491,62494,62501,62506,62508-62509,62515,62518-62519,62521,62526,62533,62539,62541,62555,62562,62566,62570,62573,62575,62585,62588,62597,62603,62606,62608-62609,62614,62618,62628,62632,62638,62642,62648-62649,62652,62654-62657,62666,62705,62709,62723,62730,62739,62741,62743,62746,62750,62752,62757,62762

Modified: grass/branches/releasebranch_7_0/lib/python/script/core.py
===================================================================
--- grass/branches/releasebranch_7_0/lib/python/script/core.py	2014-11-18 02:38:49 UTC (rev 62787)
+++ grass/branches/releasebranch_7_0/lib/python/script/core.py	2014-11-18 02:40:19 UTC (rev 62788)
@@ -571,15 +571,21 @@
 def error(msg):
     """Display an error message using `g.message -e`
 
+    This function does not end the execution of the program.
+    The right action after the error is up to the caller.
+    For error handling using the standard mechanism use :func:`fatal`.
+
     :param str msg: error message to be displayed
     """
     message(msg, flag='e')
 
 
 def fatal(msg):
-    """Display an error message using `g.message -e`, then abort
+    """Display an error message using `g.message -e`, then abort or raise
 
-    Raise exception when raise_on_error is 'True'.
+    Raises exception when module global raise_on_error is 'True', abort
+    (calls exit) otherwise.
+    Use func:`set_raise_on_error` to set the behavior.
 
     :param str msg: error message to be displayed
     """