summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOleg Pudeyev <oleg@bsdpower.com>2014-01-16 15:16:41 -0500
committerOleg Pudeyev <oleg@bsdpower.com>2014-01-16 23:28:16 -0500
commit77757d8427979aac1600ef699bb6d4e6db4a2107 (patch)
treef9e834eeb3a7b2901bc24584963fb2d33d10eda1
parentf63f340ef5e6783ca8faf6c9250a7dbc852aafa2 (diff)
downloadpycurl-77757d8427979aac1600ef699bb6d4e6db4a2107.tar.gz
Apparently restructured text is pretty limited in what it can do
-rw-r--r--doc/callbacks.rst14
-rw-r--r--doc/curlmultiobject.rst14
-rw-r--r--doc/curlobject.rst14
-rw-r--r--doc/curlshareobject.rst2
-rw-r--r--doc/pycurl.rst14
5 files changed, 29 insertions, 29 deletions
diff --git a/doc/callbacks.rst b/doc/callbacks.rst
index 1f74873..bfe1835 100644
--- a/doc/callbacks.rst
+++ b/doc/callbacks.rst
@@ -23,18 +23,18 @@ callbacks.
The signature of each callback used in pycurl is as follows:
-``WRITEFUNCTION(``*string*``) `` -> *number of characters written*
+**WRITEFUNCTION**\ (*string*) -> *number of characters written*
-``READFUNCTION(``*number of characters to read*``)`` -> *string*
+**READFUNCTION**\ (*number of characters to read*) -> *string*
-``HEADERFUNCTION(``*string*``)`` -> *number of characters written*
+**HEADERFUNCTION**\ (*string*) -> *number of characters written*
-``PROGRESSFUNCTION(``*download total, downloaded, upload total,
-uploaded*``) `` -> *status*
+**PROGRESSFUNCTION**\ (*download total, downloaded, upload total,
+uploaded*) -> *status*
-``DEBUGFUNCTION(``*debug message type, debug message string*``)`` -> *None*
+**DEBUGFUNCTION**\ (*debug message type, debug message string*) -> *None*
-``IOCTLFUNCTION(``*ioctl cmd*``)`` -> *status*
+**IOCTLFUNCTION**\ (*ioctl cmd*) -> *status*
In addition, ``READFUNCTION`` may return ``READFUNC_ABORT`` or
``READFUNC_PAUSE``. See the libcurl documentation for an explanation of these
diff --git a/doc/curlmultiobject.rst b/doc/curlmultiobject.rst
index 7c4c181..f09a8c3 100644
--- a/doc/curlmultiobject.rst
+++ b/doc/curlmultiobject.rst
@@ -3,17 +3,17 @@ CurlMulti Object
CurlMulti objects have the following methods:
-``close()`` -> *None*
+**close**\ () -> *None*
Corresponds to `curl_multi_cleanup`_ in libcurl. This method is
automatically called by pycurl when a CurlMulti object no longer has any
references to it, but can also be called explicitly.
-``perform()`` -> *tuple of status and the number of active Curl objects*
+**perform**\ () -> *tuple of status and the number of active Curl objects*
Corresponds to `curl_multi_perform`_ in libcurl.
-``add_handle(``*Curl object*``) `` -> *None*
+**add_handle**\ (*Curl object*) -> *None*
Corresponds to `curl_multi_add_handle`_ in libcurl. This method adds an
existing and valid Curl object to the CurlMulti object.
@@ -22,7 +22,7 @@ IMPORTANT NOTE: add_handle does not implicitly add a Python reference to the
Curl object (and thus does not increase the reference count on the Curl
object).
-``remove_handle(``*Curl object*``)`` -> *None*
+**remove_handle**\ (*Curl object*) -> *None*
Corresponds to `curl_multi_remove_handle`_ in libcurl. This method
removes an existing and valid Curl object from the CurlMulti object.
@@ -31,7 +31,7 @@ IMPORTANT NOTE: remove_handle does not implicitly remove a Python reference
from the Curl object (and thus does not decrease the reference count on the
Curl object).
-``fdset()`` -> *triple of lists with active file descriptors, readable,
+**fdset**\ () -> *triple of lists with active file descriptors, readable,
writeable, exceptions.*
Corresponds to `curl_multi_fdset`_ in libcurl. This method extracts the
@@ -56,7 +56,7 @@ Example usage:
ret, num_handles = m.perform()
if ret != pycurl.E_CALL_MULTI_PERFORM: break
-``select(``*timeout*``)`` -> *number of ready file descriptors or -1 on timeout*
+**select**\ (*timeout*) -> *number of ready file descriptors or -1 on timeout*
This is a convenience function which simplifies the combined use of
``fdset()`` and the ``select`` module.
@@ -80,7 +80,7 @@ Example usage:
ret, num_handles = m.perform()
if ret != pycurl.E_CALL_MULTI_PERFORM: break
-``info_read(``*[max]*``)`` -> *number of queued messages, a list of
+**info_read**\ (*[max]*) -> *number of queued messages, a list of
successful objects, a list of failed objects*
Corresponds to the `curl_multi_info_read`_ function in libcurl. This
diff --git a/doc/curlobject.rst b/doc/curlobject.rst
index 187a845..3720766 100644
--- a/doc/curlobject.rst
+++ b/doc/curlobject.rst
@@ -3,21 +3,21 @@ Curl Object
Curl objects have the following methods:
-``close()`` -> *None*
+**close**\ () -> *None*
Corresponds to `curl_easy_cleanup`_ in libcurl. This method is
automatically called by pycurl when a Curl object no longer has any
references to it, but can also be called explicitly.
-``perform()`` -> *None*
+**perform**\ () -> *None*
Corresponds to `curl_easy_perform`_ in libcurl.
-``reset()`` -> *None*
+**reset**\ () -> *None*
Corresponds to `curl_easy_reset`_ in libcurl.
-``setopt(``*option, value*``)`` -> *None*
+**setopt**\ (*option, value*) -> *None*
Corresponds to `curl_easy_setopt`_ in libcurl, where *option* is
specified with the ``CURLOPT_*`` constants in libcurl, except that the
@@ -43,7 +43,7 @@ Example usage:
print b.getvalue()
...
-``getinfo(``*option*``) `` -> *Result*
+**getinfo**\ (*option*) -> *Result*
Corresponds to `curl_easy_getinfo`_ in libcurl, where *option* is the
same as the ``CURLINFO_*`` constants in libcurl, except that the ``CURLINFO_``
@@ -65,13 +65,13 @@ Example usage:
...
--> 200 "http://sourceforge.net/"
-``pause(``*bitmask*``) `` -> *None*
+**pause**\ (*bitmask*) -> *None*
Corresponds to `curl_easy_pause`_ in libcurl. The argument should be
derived from the ``PAUSE_RECV``, ``PAUSE_SEND``, ``PAUSE_ALL`` and
``PAUSE_CONT`` constants.
-``errstr()`` -> *String*
+**errstr**\ () -> *String*
Returns the internal libcurl error buffer of this handle as a string.
diff --git a/doc/curlshareobject.rst b/doc/curlshareobject.rst
index d474b06..cf1d17b 100644
--- a/doc/curlshareobject.rst
+++ b/doc/curlshareobject.rst
@@ -3,7 +3,7 @@ CurlShare Object
CurlShare objects have the following methods:
-``setopt(``*option, value*``)`` -> *None*
+**setopt**\ (*option, value*) -> *None*
Corresponds to `curl_share_setopt`_ in libcurl, where *option* is
specified with the ``CURLSHOPT_*`` constants in libcurl, except that the
diff --git a/doc/pycurl.rst b/doc/pycurl.rst
index 295a7e9..60971df 100644
--- a/doc/pycurl.rst
+++ b/doc/pycurl.rst
@@ -19,17 +19,17 @@ how libcurl works, please consult the `curl library C API`_.
Module Functionality
--------------------
-``pycurl.global_init(``*option*``)`` ->*None*
+**pycurl.global_init**\ (*option*) -> *None*
*option* is one of the constants pycurl.GLOBAL_SSL, pycurl.GLOBAL_WIN32,
pycurl.GLOBAL_ALL, pycurl.GLOBAL_NOTHING, pycurl.GLOBAL_DEFAULT. Corresponds
to `curl_global_init`_ in libcurl.
-``pycurl.global_cleanup()`` -> *None*
+**pycurl.global_cleanup**\ () -> *None*
Corresponds to `curl_global_cleanup`_ in libcurl.
-``pycurl.version``
+**pycurl.version**
This is a string with version information on libcurl, corresponding to
`curl_version`_ in libcurl.
@@ -42,7 +42,7 @@ Example usage:
>>> pycurl.version
'PycURL/7.19.3 libcurl/7.33.0 OpenSSL/0.9.8x zlib/1.2.7'
-``pycurl.version_info()`` -> *Tuple*
+**pycurl.version_info**\ () -> *Tuple*
Corresponds to `curl_version_info`_ in libcurl. Returns a tuple of
information which is similar to the ``curl_version_info_data`` struct
@@ -59,19 +59,19 @@ Example usage:
'imap', 'imaps', 'pop3', 'pop3s', 'rtsp', 'smtp', 'smtps', 'telnet',
'tftp'), None, 0, None)
-``pycurl.Curl()`` -> *Curl object*
+**pycurl.Curl**\ () -> *Curl object*
This function creates a new `Curl object`_ which corresponds to a ``CURL``
handle in libcurl. Curl objects automatically set CURLOPT_VERBOSE to 0,
CURLOPT_NOPROGRESS to 1, provide a default CURLOPT_USERAGENT and setup
CURLOPT_ERRORBUFFER to point to a private error buffer.
-``pycurl.CurlMulti()`` -> *CurlMulti object*
+**pycurl.CurlMulti**\ () -> *CurlMulti object*
This function creates a new `CurlMulti object`_ which corresponds to a
``CURLM`` handle in libcurl.
-``pycurl.CurlShare()`` -> *CurlShare object*
+**pycurl.CurlShare**\ () -> *CurlShare object*
This function creates a new `CurlShare object`_ which corresponds to a
``CURLSH`` handle in libcurl. CurlShare objects is what you pass as an