diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2014-06-09 16:04:25 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2014-06-24 15:08:04 -0400 |
| commit | 2f40cb08524931798b19d7962aaf7cff47563db3 (patch) | |
| tree | 1e495d265fb3ec72c39ca1a910376e976a465862 /doc/curlmultiobject.rst | |
| parent | 11e29599ccf212955921915e4a01256b5b41511e (diff) | |
| download | pycurl-2f40cb08524931798b19d7962aaf7cff47563db3.tar.gz | |
Sphinx can now use method docstrings
Diffstat (limited to 'doc/curlmultiobject.rst')
| -rw-r--r-- | doc/curlmultiobject.rst | 28 |
1 files changed, 7 insertions, 21 deletions
diff --git a/doc/curlmultiobject.rst b/doc/curlmultiobject.rst index 59126d7..96fe87f 100644 --- a/doc/curlmultiobject.rst +++ b/doc/curlmultiobject.rst @@ -7,30 +7,16 @@ CurlMulti Object CurlMulti objects have the following methods: - .. method:: close() -> None + .. automethod:: pycurl.CurlMulti.close - .. include:: ../build/docstrings/multi_close.rst + .. automethod:: pycurl.CurlMulti.perform - .. method:: perform() -> tuple of status and the number of active Curl objects + .. automethod:: pycurl.CurlMulti.add_handle - .. include:: ../build/docstrings/multi_perform.rst + .. automethod:: pycurl.CurlMulti.remove_handle - .. method:: add_handle(Curl object) -> None + .. automethod:: pycurl.CurlMulti.fdset - .. include:: ../build/docstrings/multi_add_handle.rst + .. automethod:: pycurl.CurlMulti.select - .. method:: remove_handle(Curl object) -> None - - .. include:: ../build/docstrings/multi_remove_handle.rst - - .. method:: fdset() -> tuple of lists with active file descriptors, readable, writeable, exceptions - - .. include:: ../build/docstrings/multi_fdset.rst - - .. method:: select([timeout]) -> number of ready file descriptors or -1 on timeout - - .. include:: ../build/docstrings/multi_select.rst - - .. method:: info_read([max_objects]) -> tuple(number of queued messages, a list of successful objects, a list of failed objects) - - .. include:: ../build/docstrings/multi_info_read.rst + .. automethod:: pycurl.CurlMulti.info_read |