summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/create.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-03-17 12:39:27 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2021-03-17 12:40:06 -0400
commit8b275553adf317685c80c54b4c477607b1468168 (patch)
treefb6582218a51fe1502a583ed83186b3e2b6c245d /lib/sqlalchemy/engine/create.py
parentce3c1c5dad4296da54df0863d6546090fc9eb20a (diff)
downloadsqlalchemy-8b275553adf317685c80c54b4c477607b1468168.tar.gz
work around formatting issue with the :param: tag
Fixes: #6075 Change-Id: Ia3f6109e3a038ddcf513d3e887b4cad0f776f0a6
Diffstat (limited to 'lib/sqlalchemy/engine/create.py')
-rw-r--r--lib/sqlalchemy/engine/create.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/sqlalchemy/engine/create.py b/lib/sqlalchemy/engine/create.py
index 381e0879d..789030f2b 100644
--- a/lib/sqlalchemy/engine/create.py
+++ b/lib/sqlalchemy/engine/create.py
@@ -447,12 +447,14 @@ def create_engine(url, **kwargs):
:paramref:`_pool.Pool.reset_on_return`
- :param pool_timeout=30.0: number of seconds to wait before giving
+ :param pool_timeout=30: number of seconds to wait before giving
up on getting a connection from the pool. This is only used
with :class:`~sqlalchemy.pool.QueuePool`. This can be a float but is
subject to the limitations of Python time functions which may not be
reliable in the tens of milliseconds.
+ .. note: don't use 30.0 above, it seems to break with the :param tag
+
:param pool_use_lifo=False: use LIFO (last-in-first-out) when retrieving
connections from :class:`.QueuePool` instead of FIFO
(first-in-first-out). Using LIFO, a server-side timeout scheme can