summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJohn Kristensen <john@jerrykan.com>2014-03-14 12:33:55 +1100
committerJohn Kristensen <john@jerrykan.com>2014-03-14 12:33:55 +1100
commitacf2eff04462e537e71902a69bc92abfcf45be8d (patch)
tree3d6faebb07a837e8ea5f21f069722c3a65c0b87b /src
parent8a320653cbd051389481c978ba1b7494775787cd (diff)
Add missing documentation for the timeout args
Seems as though the documentation was not updated when the timeout args were added.
Diffstat (limited to 'src')
-rw-r--r--src/etcd/client.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/etcd/client.py b/src/etcd/client.py
index 4dccdd8..4dc9fa1 100644
--- a/src/etcd/client.py
+++ b/src/etcd/client.py
@@ -285,6 +285,8 @@ class Client(object):
sorted (bool): Sort the output keys (alphanumerically)
+ timeout (int): max seconds to wait for a read.
+
Returns:
client.EtcdResult (or an array of client.EtcdResult if a
subtree is queried)
@@ -292,6 +294,8 @@ class Client(object):
Raises:
KeyValue: If the key doesn't exists.
+ urllib3.exceptions.TimeoutError: If timeout is reached.
+
>>> print client.get('/key').value
'value'
@@ -415,12 +419,16 @@ class Client(object):
index (int): Index to start from.
+ timeout (int): max seconds to wait for a read.
+
Returns:
client.EtcdResult
Raises:
KeyValue: If the key doesn't exists.
+ urllib3.exceptions.TimeoutError: If timeout is reached.
+
>>> print client.watch('/key').value
'value'