From: Tom Christie <tom@tomchristie.com>
Date: Wed, 8 Jan 2020 12:33:35 +0000 (+0000)
Subject: Improve docstring for PoolLimits (#712)
X-Git-Tag: 0.11.0~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=eac4b9ba7428c41ee36837a6ddb50a75b6a87c5b;p=thirdparty%2Fhttpx.git

Improve docstring for PoolLimits (#712)

* Improve docstring for PoolLimits

* Linting for docstring
---

diff --git a/httpx/config.py b/httpx/config.py
index ef413bde..d3108649 100644
--- a/httpx/config.py
+++ b/httpx/config.py
@@ -284,6 +284,13 @@ class Timeout:
 class PoolLimits:
     """
     Limits on the number of connections in a connection pool.
+
+    **Parameters:**
+
+    * **soft_limit** - Allow the connection pool to maintain keep-alive connections
+                       below this point.
+    * **hard_limit** - The maximum number of concurrenct connections that may be
+                       established.
     """
 
     def __init__(