[Checkins] SVN: grok/trunk/doc/reference/utils.rst - Use autofunction for grok.util.getApplication

Uli Fouquet uli at gnufix.de
Mon Jan 3 01:27:46 EST 2011


Log message for revision 119277:
  - Use autofunction for grok.util.getApplication
  - Mark as deprecated in docs.
  

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:21:38 UTC (rev 119276)
+++ grok/trunk/doc/reference/utils.rst	2011-01-03 06:27:46 UTC (rev 119277)
@@ -37,16 +37,16 @@
 :func:`grok.util.getApplication`
 ================================
 
-.. function:: grok.util.getApplication()
+This function is also exported to the main grok namespace and can be
+called at :func:`grok.getApplication`.
 
-    Return the nearest enclosing `grok.Application`.
+.. autofunction:: grok.util.getApplication()
 
-    Raises ValueError if no Application can be found.
+    .. deprecated:: 1.4
+       This function has been moved to :mod:`grokcore.site`. Use
+       :func:`grokcore.site.getApplication` instead.
 
-    This function is also export to the main grok namespace and can be
-    called at `grok.getApplication`.
 
-
 :func:`grok.util.make_checker`
 ==============================
 
@@ -68,5 +68,3 @@
 
     If the object provides ILocation, __parent__ and __name__ will be
     set directly.  A location proxy will be returned otherwise.
-
-



More information about the checkins mailing list