From ee40c8641451a5bb4193d4729f378687e181abce Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Thu, 16 Apr 2015 17:04:28 -0700 Subject: Add pooled client docstring --- pymemcache/client.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/pymemcache/client.py b/pymemcache/client.py index 7f9339a..cd5304c 100644 --- a/pymemcache/client.py +++ b/pymemcache/client.py @@ -824,7 +824,18 @@ class Client(object): class PooledClient(object): - """A thread-safe pool of clients (with the same client api).""" + """A thread-safe pool of clients (with the same client api). + + :param max_pool_size: maximum pool size to use (going about this + amount triggers a runtime error), by default this + is 2147483648L when not provided. + :param lock_generator: a callback/type that takes no arguments that will + be called to create a lock or sempahore that can + protect the pool from concurrent + access (for example a eventlet lock or semaphore) + + Further arguments are interpreted as for :py:class:`.Client` constructor. + """ def __init__(self, server, -- cgit v1.2.1