From e9a62bf418d6ab9b8ff578f4afe612185fd17ec5 Mon Sep 17 00:00:00 2001 From: Shubham Sharma Date: Tue, 21 Sep 2021 22:40:31 +0530 Subject: [PATCH] Update docs Update documentation of __init__ method of ThreadedPoolConnection. The old documentation was incorrect because it says "initialze a threading lock." --- lib/pool.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/lib/pool.py b/lib/pool.py index 9d67d68e..f29fbf53 100644 --- a/lib/pool.py +++ b/lib/pool.py @@ -156,7 +156,24 @@ class ThreadedConnectionPool(AbstractConnectionPool): """A connection pool that works with the threading module.""" def __init__(self, minconn, maxconn, *args, **kwargs): - """Initialize the threading lock.""" + """Initializes a new instance of ThreadedConnectionPool. + + Parameters + ---------- + minconn : int + The minimum number of connections that should be automatically + created when you initialize the connection pool. + maxconn : int + The maximum number of connections that will be supported by this + connection pool + args : optional, positional arguments + Usually these are passed to the underlying ``connect`` method + of psycopg2 + kwargs : optional, keyword only arguments + Usually these are passed to the underlying ``connect`` method + of psycopg2 + """ + import threading AbstractConnectionPool.__init__( self, minconn, maxconn, *args, **kwargs)