Change inline docs about class fake storage variable

Adjust the docs to better describe why a fake storage
class attribute exists and how it is used and what it
represents compared to a real zookeeper setup.

Change-Id: I255ccd83c8033266e9cee09a343468ae4e0f2bfd
This commit is contained in:
Joshua Harlow 2014-09-16 17:01:33 -07:00
parent c5e1c3f96f
commit 84bb5fbef5
1 changed files with 5 additions and 1 deletions

View File

@ -25,7 +25,11 @@ class ZakeDriver(zookeeper.KazooDriver):
without the need of real ZooKeeper servers.
"""
# here we need to pass *threading handler* as an argument
# NOTE(harlowja): this creates a shared backend 'storage' layer that
# would typically exist inside a zookeeper server, but since zake has
# no concept of a 'real' zookeeper server we create a fake one and share
# it among active clients to simulate zookeeper's consistent storage in
# a thread-safe manner.
fake_storage = fake_storage.FakeStorage(
fake_client.k_threading.SequentialThreadingHandler())