# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@logilab.fr>
# Date 1369917992 -7200
# Node ID 525915f8bc1cbcea70faa969d95d0ac84c2b8e2c
# Parent  dcd8aa47adcef682236dc2d219549e61cadf184b
[web/application] add some minimal documentation

Some documentation to the Application main entry point.

diff -r dcd8aa47adce -r 525915f8bc1c web/application.py
--- a/web/application.py	Thu May 23 19:25:24 2013 +0200
+++ b/web/application.py	Thu May 30 14:46:32 2013 +0200
@@ -273,6 +273,10 @@
 class CubicWebPublisher(object):
     """the publisher is a singleton hold by the web frontend, and is responsible
     to publish HTTP request.
+
+    The http server will call its main entry point ``application.handle_request``.
+
+    .. automethod:: cubicweb.web.application.CubicWebPublisher.main_handle_request
     """
 
     def __init__(self, config,
@@ -339,6 +343,15 @@
 
 
     def main_handle_request(self, req, path):
+        """Process and http request
+
+        Arguments are:
+        - a Request object
+        - path of the request object
+
+        It return the content of the http response. HTTP header and status are
+        are set on the Request Object.
+        """
         if not isinstance(req, CubicWebRequestBase):
             warn('[3.15] Application entry poin arguments are now (req, path) '
                  'not (path, req)', DeprecationWarning, 2)