Typo in documentation ('timeout' -> 'pool_timeout')

Issue #988 resolved
Former user created an issue

At http://www.sqlalchemy.org/docs/04/pooling.html

Section 'QueuePool options include:'

...

timeout=30 : the number of seconds to wait before giving up on returning a connection

Probably typo: 'timeout' -> 'pool_timeout'

Comments (2)

  1. Michael Trier

    The confusion is that QueuePool actually does accept a timeout parameter as specified. Although the documentation does make reference to the create_engine. In the case of create_engine it accepts a pool_timeout parameter. It looks like we either need to normalize the parameter names or clarify the documentation a bit.

  2. Log in to comment