From: Ben Darnell <ben@bendarnell.com>
Date: Sun, 15 Jun 2014 16:36:28 +0000 (-0400)
Subject: Document AsyncHTTPClient's defaults argument.
X-Git-Tag: v4.0.0b1~18
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ac05c50ca6c9c37584ac4d88c329b33c89a87d01;p=thirdparty%2Ftornado.git

Document AsyncHTTPClient's defaults argument.

Closes #762.
---

diff --git a/tornado/httpclient.py b/tornado/httpclient.py
index a7a187c9b..f93c3c3cf 100644
--- a/tornado/httpclient.py
+++ b/tornado/httpclient.py
@@ -110,10 +110,21 @@ class AsyncHTTPClient(Configurable):
     actually creates an instance of an implementation-specific
     subclass, and instances are reused as a kind of pseudo-singleton
     (one per `.IOLoop`).  The keyword argument ``force_instance=True``
-    can be used to suppress this singleton behavior.  Constructor
-    arguments other than ``io_loop`` and ``force_instance`` are
-    deprecated.  The implementation subclass as well as arguments to
-    its constructor can be set with the static method `configure()`
+    can be used to suppress this singleton behavior.  Unless
+    ``force_instance=True`` is used, no arguments other than
+    ``io_loop`` should be passed to the `AsyncHTTPClient` constructor.
+    The implementation subclass as well as arguments to its
+    constructor can be set with the static method `configure()`
+
+    All `AsyncHTTPClient` implementations support a ``defaults``
+    keyword argument, which can be used to set default values for
+    `HTTPRequest` attributes.  For example::
+
+        AsyncHTTPClient.configure(
+            None, defaults=dict(user_agent="MyUserAgent"))
+        # or with force_instance:
+        client = AsyncHTTPClient(force_instance=True,
+            defaults=dict(user_agent="MyUserAgent"))
     """
     @classmethod
     def configurable_base(cls):