[Checkins] SVN: grok/trunk/doc/reference/utils.rst - Use autofunction where possible.

Uli Fouquet uli at gnufix.de
Mon Jan 3 01:47:51 EST 2011


Log message for revision 119279:
  - Use autofunction where possible.
  
  - Set reference to grok.util.
  

Changed:
  U   grok/trunk/doc/reference/utils.rst

-=-
Modified: grok/trunk/doc/reference/utils.rst
===================================================================
--- grok/trunk/doc/reference/utils.rst	2011-01-03 06:38:14 UTC (rev 119278)
+++ grok/trunk/doc/reference/utils.rst	2011-01-03 06:47:51 UTC (rev 119279)
@@ -5,35 +5,28 @@
 The :mod:`grok.util` module provides functions which are less commonly
 used, and so are not available for import directly from the :mod:`grok` module.
 
+.. module:: grok.util
+
 :func:`grok.util.application_url`
 =================================
 
-.. function:: grok.util.application_url(request, obj, name=None, data={})`
+This function is also available as a method on the :class:`grok.View` class.
 
-    Return the URL of the nearest enclosing `grok.Application`.
+.. autofunction:: grok.util.application_url
 
-    Raises ValueError if no Application can be found.
-    
-    This function is also available as a method on the `grok.View` class.
 
-
 :func:`grok.util.applySkin`
 ===========================
 
-.. function:: grok.util.applySkin(request, skin, skin_type)
+.. autofunction:: grok.util.applySkin
 
-    Change the presentation skin for this request.
 
-
 :func:`grok.util.create_application`
 ====================================
 
-.. function:: grok.util.create_application(factory, container, name)
+.. autofunction:: grok.util.create_application
 
-    Creates an application and triggers the events from
-    the application lifecycle.
 
-
 :func:`grok.util.getApplication`
 ================================
 
@@ -61,10 +54,4 @@
 :func:`grok.util.safely_locate_maybe`
 =====================================
 
-.. function:: grok.util.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.
-
-    If the object provides ILocation, __parent__ and __name__ will be
-    set directly.  A location proxy will be returned otherwise.
+.. autofunction:: grok.util.safely_locate_maybe



More information about the checkins mailing list