From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Mon, 13 Sep 2010 20:37:50 +0000 (+0000)
Subject: Enhanced HTTPHandler documentation.
X-Git-Tag: v3.2a3~280
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1b5646ac569e493721364856b45629d6e5a46d6a;p=thirdparty%2FPython%2Fcpython.git

Enhanced HTTPHandler documentation.
---

diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index f3d144557d1b..d28d4fae7823 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -2578,12 +2578,16 @@ supports sending logging messages to a Web server, using either ``GET`` or
 ``POST`` semantics.
 
 
-.. class:: HTTPHandler(host, url, method='GET')
-
-   Returns a new instance of the :class:`HTTPHandler` class. The instance is
-   initialized with a host address, url and HTTP method. The *host* can be of the
-   form ``host:port``, should you need to use a specific port number. If no
-   *method* is specified, ``GET`` is used.
+.. class:: HTTPHandler(host, url, method='GET', secure=False, credentials=None)
+
+   Returns a new instance of the :class:`HTTPHandler` class. The *host* can be
+   of the form ``host:port``, should you need to use a specific port number.
+   If no *method* is specified, ``GET`` is used. If *secure* is True, an HTTPS
+   connection will be used. If *credentials* is specified, it should be a
+   2-tuple consisting of userid and password, which will be placed in an HTTP
+   'Authorization' header using Basic authentication. If you specify
+   credentials, you should also specify secure=True so that your userid and
+   password are not passed in cleartext across the wire.
 
 
    .. method:: emit(record)