summaryrefslogtreecommitdiff
path: root/efl/ethumb
diff options
context:
space:
mode:
authorDave Andreoli <dave@gurumeditation.it>2015-01-03 20:17:24 +0100
committerDave Andreoli <dave@gurumeditation.it>2015-01-03 20:17:24 +0100
commit6ff99982587c8e44b84bd384eb06ab28e6b558cf (patch)
tree26d2297aa3371e46bff846d5b3bde67ee0c7ca00 /efl/ethumb
parent64c1d33c9f69ec43e342337cb06920b83781cb86 (diff)
Lots of documentation fixes for ALL the classes
Mainly with regard of class __init__ params and the **keyword param
Diffstat (limited to 'efl/ethumb')
-rw-r--r--efl/ethumb/efl.ethumb_client.pyx21
1 files changed, 11 insertions, 10 deletions
diff --git a/efl/ethumb/efl.ethumb_client.pyx b/efl/ethumb/efl.ethumb_client.pyx
index f46f29b..569a176 100644
--- a/efl/ethumb/efl.ethumb_client.pyx
+++ b/efl/ethumb/efl.ethumb_client.pyx
@@ -114,20 +114,21 @@ cdef class Client:
114 """ 114 """
115 115
116 def __init__(self, func, *args, **kargs): 116 def __init__(self, func, *args, **kargs):
117 """ 117 """Client(...)
118
119 Ethumb Client constructor.
120
121 Server is ready to receive requests just after **func** is
122 called back with ``status == True``.
123 118
124 :param func: function to call when connection with server is 119 :param func: function to call when connection with server is
125 established. Function signature is:: 120 established.
121 :param \*args: Any other parameters will be passed back in the
122 callback function
123 :keyword \**kargs: Any other keyword parameters will be passed back
124 in the callback function
125
126 Expected **func** signature::
126 127
127 func(client, status, *args, **kargs) 128 func(client, status, *args, **kargs)
128 129
129 with status being True for successful connection or False 130 with status being **True** for successful connection or **False**
130 on error. 131 on error.
131 132
132 :raise TypeError: if **func** is not callable. 133 :raise TypeError: if **func** is not callable.
133 :raise SystemError: if it was not possible to connect to 134 :raise SystemError: if it was not possible to connect to