]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
work around formatting issue with the :param: tag
authorMike Bayer <mike_mp@zzzcomputing.com>
Wed, 17 Mar 2021 16:39:27 +0000 (12:39 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Wed, 17 Mar 2021 16:40:06 +0000 (12:40 -0400)
Fixes: #6075
Change-Id: Ia3f6109e3a038ddcf513d3e887b4cad0f776f0a6

lib/sqlalchemy/engine/create.py

index 381e0879d7b0c83589e4137f0a9a0884afa674d3..789030f2bc6d73b8b0ef0d78d0ab199310704e7b 100644 (file)
@@ -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