Skip to content

Commit 871a45d

Browse files
committed
docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.
1 parent f2babea commit 871a45d

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/library/uselect.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Methods
5252

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

docs/library/ussl.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Functions
1313

1414
.. function:: ssl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
1515

16-
Takes a stream `sock` (usually usocket.socket instance of ``SOCK_STREAM`` type),
16+
Takes a stream *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
1717
and returns an instance of ssl.SSLSocket, which wraps the underlying stream in
1818
an SSL context. Returned object has the usual stream interface methods like
1919
`read()`, `write()`, etc. In MicroPython, the returned object does not expose
@@ -43,4 +43,4 @@ Constants
4343
ssl.CERT_OPTIONAL
4444
ssl.CERT_REQUIRED
4545

46-
Supported values for `cert_reqs` parameter.
46+
Supported values for *cert_reqs* parameter.

docs/library/ustruct.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,26 @@ Functions
1818

1919
.. function:: calcsize(fmt)
2020

21-
Return the number of bytes needed to store the given `fmt`.
21+
Return the number of bytes needed to store the given *fmt*.
2222

2323
.. function:: pack(fmt, v1, v2, ...)
2424

25-
Pack the values `v1`, `v2`, ... according to the format string `fmt`.
25+
Pack the values *v1*, *v2*, ... according to the format string *fmt*.
2626
The return value is a bytes object encoding the values.
2727

2828
.. function:: pack_into(fmt, buffer, offset, v1, v2, ...)
2929

30-
Pack the values `v1`, `v2`, ... according to the format string `fmt`
31-
into a `buffer` starting at `offset`. `offset` may be negative to count
32-
from the end of `buffer`.
30+
Pack the values *v1*, *v2*, ... according to the format string *fmt*
31+
into a *buffer* starting at *offset*. *offset* may be negative to count
32+
from the end of *buffer*.
3333

3434
.. function:: unpack(fmt, data)
3535

36-
Unpack from the `data` according to the format string `fmt`.
36+
Unpack from the *data* according to the format string *fmt*.
3737
The return value is a tuple of the unpacked values.
3838

3939
.. function:: unpack_from(fmt, data, offset=0)
4040

41-
Unpack from the `data` starting at `offset` according to the format string
42-
`fmt`. `offset` may be negative to count from the end of `buffer`. The return
41+
Unpack from the *data* starting at *offset* according to the format string
42+
*fmt*. *offset* may be negative to count from the end of *buffer*. The return
4343
value is a tuple of the unpacked values.

0 commit comments

Comments
 (0)