From: Ben Darnell <ben@bendarnell.com>
Date: Mon, 27 Aug 2012 21:49:20 +0000 (-0400)
Subject: Fill in missing docs and other minor doc updates.
X-Git-Tag: v2.4.0~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5eb9821e68c86e1d94c7f2144b19a4e83a05dcb2;p=thirdparty%2Ftornado.git

Fill in missing docs and other minor doc updates.
---

diff --git a/tornado/httputil.py b/tornado/httputil.py
index 6f5d07a68..0f8a8438d 100644
--- a/tornado/httputil.py
+++ b/tornado/httputil.py
@@ -207,6 +207,13 @@ class HTTPFile(ObjectDict):
 
 
 def parse_body_arguments(content_type, body, arguments, files):
+    """Parses a form request body.
+
+    Supports "application/x-www-form-urlencoded" and "multipart/form-data".
+    The content_type parameter should be a string and body should be
+    a byte string.  The arguments and files parameters are dictionaries
+    that will be updated with the parsed contents.
+    """
     if content_type.startswith("application/x-www-form-urlencoded"):
         uri_arguments = parse_qs_bytes(native_str(body))
         for name, values in uri_arguments.iteritems():
diff --git a/website/sphinx/releases/next.rst b/website/sphinx/releases/next.rst
index 01e7d4584..383a20042 100644
--- a/website/sphinx/releases/next.rst
+++ b/website/sphinx/releases/next.rst
@@ -36,9 +36,8 @@ In progress
 * `SSLIOStream.get_ssl_certificate` now has a ``binary_form`` argument
   which is passed to ``SSLSocket.getpeercert``.
 * `SSLIOStream.write` can now be called while the connection is in progress,
-  same as non-SSL `IOStream`.
-* tornado.util.GzipDecompressor, tornado.httputil.parse_body_arguments (TODO
-  are these public?)
+  same as non-SSL `IOStream` (but be careful not to send sensitive data until
+  the connection has completed and the certificate has been verified).
 * `OpenIDMixin` now also returns the ``claimed_id`` field for the user.
 * New method `RequestHandler.get_template_namespace` can be overridden to
   add additional variables without modifying keyword arguments to
diff --git a/website/sphinx/testing.rst b/website/sphinx/testing.rst
index 5b8758c38..38738085b 100644
--- a/website/sphinx/testing.rst
+++ b/website/sphinx/testing.rst
@@ -11,7 +11,10 @@
 
    .. autoclass:: AsyncHTTPTestCase
       :members:
-   
+
+   .. autoclass:: AsyncHTTPSTestCase
+      :members:
+
    Controlling log output
    ----------------------
 
diff --git a/website/sphinx/web.rst b/website/sphinx/web.rst
index e8c1cd33e..2e1b8a464 100644
--- a/website/sphinx/web.rst
+++ b/website/sphinx/web.rst
@@ -41,6 +41,7 @@
    .. automethod:: RequestHandler.set_status
    .. automethod:: RequestHandler.set_header
    .. automethod:: RequestHandler.add_header
+   .. automethod:: RequestHandler.clear_header
    .. automethod:: RequestHandler.set_default_headers
    .. automethod:: RequestHandler.write
    .. automethod:: RequestHandler.flush