summaryrefslogtreecommitdiff
path: root/tooz/drivers/zake.py
diff options
context:
space:
mode:
authorJoshua Harlow <harlowja@yahoo-inc.com>2015-04-08 12:12:58 -0700
committerJoshua Harlow <harlowja@yahoo-inc.com>2015-04-08 12:35:07 -0700
commit6569329e9b314c55763ee40805b617d5e78c965f (patch)
tree78c9204c8c5434023638e0ba72aed4188c4a75ee /tooz/drivers/zake.py
parent9efa54a75b23cb638b88708c262bbbb39e5a0d6d (diff)
downloadtooz-6569329e9b314c55763ee40805b617d5e78c965f.tar.gz
Beef up the docstrings on the various drivers
Change-Id: I1ca05629cc5f28c1248767bb18384a29801bece2
Diffstat (limited to 'tooz/drivers/zake.py')
-rw-r--r--tooz/drivers/zake.py10
1 files changed, 8 insertions, 2 deletions
diff --git a/tooz/drivers/zake.py b/tooz/drivers/zake.py
index e10f365..5c19e81 100644
--- a/tooz/drivers/zake.py
+++ b/tooz/drivers/zake.py
@@ -21,8 +21,14 @@ from tooz.drivers import zookeeper
class ZakeDriver(zookeeper.KazooDriver):
- """The driver using the Zake client which mimic a fake Kazoo client
- without the need of real ZooKeeper servers.
+ """This driver uses the `zake`_ client to mimic real `zookeeper`_ servers.
+
+ It **should** be mainly used (and **is** really only intended to be used in
+ this manner) for testing and integration (where real `zookeeper`_ servers
+ are typically not available).
+
+ .. _zake: https://pypi.python.org/pypi/zake
+ .. _zookeeper: http://zookeeper.apache.org/
"""
# NOTE(harlowja): this creates a shared backend 'storage' layer that