docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.

pull/3184/head
Paul Sokolovsky 2017-06-30 00:34:52 +03:00
rodzic f2babeaeda
commit 871a45dd0c
3 zmienionych plików z 11 dodań i 11 usunięć

Wyświetl plik

@ -52,7 +52,7 @@ Methods
Wait for at least one of the registered objects to become ready. Returns
list of (``obj``, ``event``, ...) tuples, ``event`` element specifies
which events happened with a stream and is a combination of `select.POLL*`
which events happened with a stream and is a combination of ``select.POLL*``
constants described above. There may be other elements in tuple, depending
on a platform and version, so don't assume that its size is 2. In case of
timeout, an empty list is returned.

Wyświetl plik

@ -13,7 +13,7 @@ Functions
.. function:: ssl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
Takes a stream `sock` (usually usocket.socket instance of ``SOCK_STREAM`` type),
Takes a stream *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
and returns an instance of ssl.SSLSocket, which wraps the underlying stream in
an SSL context. Returned object has the usual stream interface methods like
`read()`, `write()`, etc. In MicroPython, the returned object does not expose
@ -43,4 +43,4 @@ Constants
ssl.CERT_OPTIONAL
ssl.CERT_REQUIRED
Supported values for `cert_reqs` parameter.
Supported values for *cert_reqs* parameter.

Wyświetl plik

@ -18,26 +18,26 @@ Functions
.. function:: calcsize(fmt)
Return the number of bytes needed to store the given `fmt`.
Return the number of bytes needed to store the given *fmt*.
.. function:: pack(fmt, v1, v2, ...)
Pack the values `v1`, `v2`, ... according to the format string `fmt`.
Pack the values *v1*, *v2*, ... according to the format string *fmt*.
The return value is a bytes object encoding the values.
.. function:: pack_into(fmt, buffer, offset, v1, v2, ...)
Pack the values `v1`, `v2`, ... according to the format string `fmt`
into a `buffer` starting at `offset`. `offset` may be negative to count
from the end of `buffer`.
Pack the values *v1*, *v2*, ... according to the format string *fmt*
into a *buffer* starting at *offset*. *offset* may be negative to count
from the end of *buffer*.
.. function:: unpack(fmt, data)
Unpack from the `data` according to the format string `fmt`.
Unpack from the *data* according to the format string *fmt*.
The return value is a tuple of the unpacked values.
.. function:: unpack_from(fmt, data, offset=0)
Unpack from the `data` starting at `offset` according to the format string
`fmt`. `offset` may be negative to count from the end of `buffer`. The return
Unpack from the *data* starting at *offset* according to the format string
*fmt*. *offset* may be negative to count from the end of *buffer*. The return
value is a tuple of the unpacked values.