[svn] More doc updates

--HG--
branch : trunk

1 files changed, 32 insertions, 0 deletions

diff --git a/routes/__init__.py b/routes/__init__.py
index 8f63987..8796ca1 100644
--- a/routes/__init__.py
+++ b/routes/__init__.py
@@ -23,6 +23,38 @@ else:
           return self.__shared_state.__setattr__(name, value)
   
 def request_config():
+    """
+    Returns the Routes RequestConfig object.
+    
+    This object is a thread-local singleton that should be initialized by
+    the web framework that is utilizing Routes.
+    
+    To get the Routes RequestConfig:
+    
+    >>> from routes import *
+    >>> config = routes.request_config()
+    
+    The following attributes must be set on the config object every request:
+    
+    mapper
+        mapper should be a Mapper instance thats ready for use
+    host
+        host is the hostname of the webapp
+    protocol
+        protocol is the protocol of the current request
+    mapper_dict
+        mapper_dict should be the dict returned by mapper.match()
+    redirect
+        redirect should be a function that issues a redirect, 
+        and takes a url as the sole argument
+    prefix (optional)
+        Set if the application is moved under a URL prefix. Prefix
+        will be stripped before matching, and prepended on generation
+    environ (optional)
+        Set to the WSGI environ for automatic prefix support if the
+        webapp is underneath a 'SCRIPT_NAME'
+    
+    """
     return _RequestConfig()
     
 from base import Mapper