diff options
author | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-07-10 16:10:34 -0700 |
---|---|---|
committer | Joshua Harlow <harlowja@gmail.com> | 2015-07-17 09:06:12 -0700 |
commit | 050a52dfb17a9920c1fcec490e2a78eb5e95708b (patch) | |
tree | 78b62f69196b174f119c6d908eb057db33b7d064 /taskflow/persistence | |
parent | b8d2a5f18e71a870e36719f60cfc0650a8ea686b (diff) | |
download | taskflow-050a52dfb17a9920c1fcec490e2a78eb5e95708b.tar.gz |
Update 'make_client' kazoo docs and link to them
Since the creation of a client is somewhat important
and knowing what the options that are transfereed to kazoo
are we should explicitly document what keys are and what
the values should be.
Change-Id: I1a5037b274828190270ea5c402be8b2100306de4
Diffstat (limited to 'taskflow/persistence')
-rw-r--r-- | taskflow/persistence/backends/impl_zookeeper.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/taskflow/persistence/backends/impl_zookeeper.py b/taskflow/persistence/backends/impl_zookeeper.py index 687f103..1189723 100644 --- a/taskflow/persistence/backends/impl_zookeeper.py +++ b/taskflow/persistence/backends/impl_zookeeper.py @@ -39,6 +39,16 @@ class ZkBackend(path_based.PathBasedBackend): "hosts": "192.168.0.1:2181,192.168.0.2:2181,192.168.0.3:2181", "path": "/taskflow", } + + Do note that the creation of a kazoo client is achieved + by :py:func:`~taskflow.utils.kazoo_utils.make_client` and the transfer + of this backend configuration to that function to make a + client may happen at ``__init__`` time. This implies that certain + parameters from this backend configuration may be provided to + :py:func:`~taskflow.utils.kazoo_utils.make_client` such + that if a client was not provided by the caller one will be created + according to :py:func:`~taskflow.utils.kazoo_utils.make_client`'s + specification """ #: Default path used when none is provided. |