1
0
Fork 0
mirror of https://github.com/mperham/connection_pool synced 2023-03-27 23:22:21 -04:00

Merge pull request #57 from rbishop/make-comments-coherent

Move docs for TimedStack to just above the TimedStack class definition
This commit is contained in:
Mike Perham 2014-05-01 12:56:52 -07:00
commit 6af7c1290b

View file

@ -4,7 +4,14 @@ require 'timeout'
##
# Raised when you attempt to retrieve a connection from a pool that has been
# shut down.
#
class ConnectionPool::PoolShuttingDownError < RuntimeError; end
##
# The TimedStack manages a pool of homogeneous connections (or any resource
# you wish to manage). Connections are created lazily up to a given maximum
# number.
# Examples:
#
# ts = TimedStack.new(1) { MyConnection.new }
@ -19,13 +26,6 @@ require 'timeout'
# ts.pop timeout: 5
# #=> raises Timeout::Error after 5 seconds
class ConnectionPool::PoolShuttingDownError < RuntimeError; end
##
# The TimedStack manages a pool of homogeneous connections (or any resource
# you wish to manage). Connections are created lazily up to a given maximum
# number.
class ConnectionPool::TimedStack
##