From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Wed, 17 Mar 2021 16:39:27 +0000 (-0400)
Subject: work around formatting issue with the :param: tag
X-Git-Tag: rel_1_4_1~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8b275553adf317685c80c54b4c477607b1468168;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

work around formatting issue with the :param: tag

Fixes: #6075
Change-Id: Ia3f6109e3a038ddcf513d3e887b4cad0f776f0a6
---

diff --git a/lib/sqlalchemy/engine/create.py b/lib/sqlalchemy/engine/create.py
index 381e0879d7..789030f2bc 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