aboutsummaryrefslogtreecommitdiffstats
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
parentAdded new convenience class: DialogWindow (diff)
downloadpython-efl-6ff99982587c8e44b84bd384eb06ab28e6b558cf.tar.gz
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:
"""
def __init__(self, func, *args, **kargs):
- """
-
- Ethumb Client constructor.
-
- Server is ready to receive requests just after **func** is
- called back with ``status == True``.
+ """Client(...)
:param func: function to call when connection with server is
- established. Function signature is::
+ established.
+ :param \*args: Any other parameters will be passed back in the
+ callback function
+ :keyword \**kargs: Any other keyword parameters will be passed back
+ in the callback function
+
+ Expected **func** signature::
- func(client, status, *args, **kargs)
+ func(client, status, *args, **kargs)
- with status being True for successful connection or False
- on error.
+ with status being **True** for successful connection or **False**
+ on error.
:raise TypeError: if **func** is not callable.
:raise SystemError: if it was not possible to connect to