Browse Source

pythonlib: use Sphinx links and other syntax changes

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@65612 15284696-431f-4ddb-bdfa-cd5b030d7da7
Vaclav Petras 9 years ago
parent
commit
f532d48c84
1 changed files with 11 additions and 6 deletions
  1. 11 6
      lib/python/script/core.py

+ 11 - 6
lib/python/script/core.py

@@ -376,7 +376,11 @@ def run_command(*args, **kwargs):
     >>> run_command('g.region', raster='elevation')
     >>> run_command('g.region', raster='elevation')
     0
     0
 
 
-    See ``start_command()`` for details about parameters and usage.
+    See :func:`start_command()` for details about parameters and usage.
+
+    ..note::
+        You should ignore the return value of this function unless, you
+        change the default behavior using *errors* parameter.
 
 
     :param *args: unnamed arguments passed to ``start_command()``
     :param *args: unnamed arguments passed to ``start_command()``
     :param **kwargs: named arguments passed to ``start_command()``
     :param **kwargs: named arguments passed to ``start_command()``
@@ -603,7 +607,7 @@ def error(msg):
 
 
     This function does not end the execution of the program.
     This function does not end the execution of the program.
     The right action after the error is up to the caller.
     The right action after the error is up to the caller.
-    For error handling using the standard mechanism use :func:`fatal`.
+    For error handling using the standard mechanism use :func:`fatal()`.
 
 
     :param str msg: error message to be displayed
     :param str msg: error message to be displayed
     """
     """
@@ -615,7 +619,7 @@ def fatal(msg):
 
 
     Raises exception when module global raise_on_error is 'True', abort
     Raises exception when module global raise_on_error is 'True', abort
     (calls exit) otherwise.
     (calls exit) otherwise.
-    Use func:`set_raise_on_error` to set the behavior.
+    Use :func:`set_raise_on_error()` to set the behavior.
 
 
     :param str msg: error message to be displayed
     :param str msg: error message to be displayed
     """
     """
@@ -988,7 +992,7 @@ def region_env(region3d=False, **kwargs):
     If no 'kwargs' are given then the current region is used. Note
     If no 'kwargs' are given then the current region is used. Note
     that this function doesn't modify the current region!
     that this function doesn't modify the current region!
 
 
-    See also use_temp_region() for alternative method how to define
+    See also :func:`use_temp_region()` for alternative method how to define
     temporary region used for raster-based computation.
     temporary region used for raster-based computation.
 
 
     :param bool region3d: True to get 3D region
     :param bool region3d: True to get 3D region
@@ -1517,11 +1521,12 @@ def debug_level():
 def legal_name(s):
 def legal_name(s):
     """Checks if the string contains only allowed characters.
     """Checks if the string contains only allowed characters.
 
 
-    This is the Python implementation of G_legal_filename() function.
+    This is the Python implementation of :func:`G_legal_filename()` function.
 
 
     ..note::
     ..note::
 
 
-        It is not clear when to use this function.
+        It is not clear when exactly use this function, but it might be
+        useful anyway for checking map names and column names.
     """
     """
     if not s or s[0] == '.':
     if not s or s[0] == '.':
         warning(_("Illegal filename <%s>. Cannot be 'NULL' or start with " \
         warning(_("Illegal filename <%s>. Cannot be 'NULL' or start with " \