]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
Improve docstring for PoolLimits (#712)
authorTom Christie <tom@tomchristie.com>
Wed, 8 Jan 2020 12:33:35 +0000 (12:33 +0000)
committerGitHub <noreply@github.com>
Wed, 8 Jan 2020 12:33:35 +0000 (12:33 +0000)
* Improve docstring for PoolLimits

* Linting for docstring

httpx/config.py

index ef413bde0ee7f8c72305e9d01e533c2ee8e9f049..d31086493c1f028b34eea8c95a9c87d90bacc18f 100644 (file)
@@ -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__(