Skip to content

Commit

Permalink
api: document "agent" parameter to request()
Browse files Browse the repository at this point in the history
Add API documentation for the "agent" keyword parameter to the request()
method.
  • Loading branch information
ktdreyer committed Feb 7, 2019
1 parent 2d45c82 commit 333b22e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/treq/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ def request(method, url, **kwargs):
:param bool unbuffered: Pass ``True`` to to disable response buffering. By
default treq buffers the entire response body in memory.
:param agent: Provide your own custom agent. Use this to override things
like ``connectTimeout`` or ``BrowserLikePolicyForHTTPS``. By
default, treq will create its own Agent with reasonable
defaults.
:type agent: twisted.web.iweb.IAgent
:rtype: Deferred that fires with an IResponse provider.
"""
Expand Down

0 comments on commit 333b22e

Please sign in to comment.