diff mercurial/hgweb/request.py @ 26132:9df8c729e2e7

hgweb: add some documentation It took longer than I wanted to grok how the various parts of hgweb worked. So I added some class and method documentation to help whoever hacks on this next.
author Gregory Szorc <gregory.szorc@gmail.com>
date Sat, 22 Aug 2015 13:58:59 -0700
parents 328739ea70c3
children 461e7b700fdf
line wrap: on
line diff
--- a/mercurial/hgweb/request.py	Tue Sep 01 23:35:06 2015 +0800
+++ b/mercurial/hgweb/request.py	Sat Aug 22 13:58:59 2015 -0700
@@ -40,6 +40,12 @@
     return form
 
 class wsgirequest(object):
+    """Higher-level API for a WSGI request.
+
+    WSGI applications are invoked with 2 arguments. They are used to
+    instantiate instances of this class, which provides higher-level APIs
+    for obtaining request parameters, writing HTTP output, etc.
+    """
     def __init__(self, wsgienv, start_response):
         version = wsgienv['wsgi.version']
         if (version < (1, 0)) or (version >= (2, 0)):