[Checkins] SVN: grok/trunk/src/grok/util.py Brush up docstring markup.

[Uli Fouquet]

Log message for revision 119278:
  Brush up docstring markup.
  

Changed:
  U   grok/trunk/src/grok/util.py

-=-
Modified: grok/trunk/src/grok/util.py
===================================================================
--- grok/trunk/src/grok/util.py	2011-01-03 06:27:46 UTC (rev 119277)
+++ grok/trunk/src/grok/util.py	2011-01-03 06:38:14 UTC (rev 119278)
@@ -24,11 +24,12 @@
 
 
 def safely_locate_maybe(obj, parent, name):
-    """Set an object's __parent__ (and __name__) if the object's
-    __parent__ attribute doesn't exist yet or is None.
+    """Set an object's ``__parent__`` (and ``__name__``) if the object's
+    ``__parent__`` attribute doesn't exist yet or is ``None``.
 
-    If the object provides ILocation, __parent__ and __name__ will be
-    set directly.  A location proxy will be returned otherwise.
+    If the object provides ``ILocation``, ``__parent__`` and
+    ``__name__`` will be set directly.  A location proxy will be
+    returned otherwise.
     """
     if getattr(obj, '__parent__', None) is not None:
         return obj
@@ -48,9 +49,9 @@
 
 
 def application_url(request, obj, name=None, data={}):
-    """Return the URL of the nearest enclosing `grok.Application`.
+    """Return the URL of the nearest enclosing :class:`grok.Application`.
 
-    Raises ValueError if no Application can be found.
+    Raises :exc:`ValueError` if no application can be found.
     """
     return url(request, getApplication(), name, data)