diff options
author | Hanno Schlichting <hanno@hannosch.eu> | 2012-08-30 23:52:04 +0200 |
---|---|---|
committer | Hanno Schlichting <hanno@hannosch.eu> | 2012-08-30 23:52:04 +0200 |
commit | b0e40e700b70ed2522b69d589c1d5b7016988d84 (patch) | |
tree | 74669790cdff2fea19a094a6d3be74ccffaedcbe /docs | |
parent | b46b9c41c85f49f5f6ce1063fca95d0f98071b00 (diff) | |
download | kazoo-b0e40e700b70ed2522b69d589c1d5b7016988d84.tar.gz |
document client.state and avoid describing internals of client.retry
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api/client.rst | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/api/client.rst b/docs/api/client.rst index 96f12b8..6a6f27e 100644 --- a/docs/api/client.rst +++ b/docs/api/client.rst @@ -19,7 +19,13 @@ Public API The :class:`~kazoo.interfaces.IHandler` strategy used by this client. Gives access to appropriate synchronization objects. - .. attribute:: retry + .. method:: retry(func, *args, **kwargs) - An instance of :class:`~kazoo.retry.KazooRetry` acting as a wrapper - to retry other methods, See :ref:`retrying_commands`. + Runs the given function with the provided arguments, retrying if it + fails because the ZooKeeper connection is lost, + see :ref:`retrying_commands`. + + .. attribute:: state + + A :class:`~kazoo.protocol.states.KazooState` attribute indicating the + current higher-level connection state. |