Skip to content

Commit 3ff7040

Browse files
committed
docs/library: Add xrefs to "stream" dictionary entry for many modules.
1 parent 75d3c04 commit 3ff7040

11 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/library/btree.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:synopsis: simple BTree database
66

77
The ``btree`` module implements a simple key-value database using external
8-
storage (disk files, or in general case, a random-access stream). Keys are
8+
storage (disk files, or in general case, a random-access `stream`). Keys are
99
stored sorted in the database, and besides efficient retrieval by a key
1010
value, a database also supports efficient ordered range scans (retrieval
1111
of values with the keys in a given range). On the application interface

docs/library/machine.UART.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ are supported.
2424

2525
WiPy/CC3200: Bits can be 5, 6, 7, 8. Stop can be 1 or 2.
2626

27-
A UART object acts like a stream object and reading and writing is done
27+
A UART object acts like a `stream` object and reading and writing is done
2828
using the standard stream methods::
2929

3030
uart.read(10) # read 10 characters, returns a bytes object

docs/library/pyb.UART.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ UART objects can be created and initialised using::
2323
*Note:* with parity=None, only 8 and 9 bits are supported. With parity enabled,
2424
only 7 and 8 bits are supported.
2525

26-
A UART object acts like a stream object and reading and writing is done
26+
A UART object acts like a `stream` object and reading and writing is done
2727
using the standard stream methods::
2828

2929
uart.read(10) # read 10 characters, returns a bytes object

docs/library/pyb.USB_VCP.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
class USB_VCP -- USB virtual comm port
55
======================================
66

7-
The USB_VCP class allows creation of an object representing the USB
7+
The USB_VCP class allows creation of a `stream`-like object representing the USB
88
virtual comm port. It can be used to read and write data over USB to
99
the connected host.
1010

@@ -47,7 +47,7 @@ Methods
4747
Read at most ``nbytes`` from the serial device and return them as a
4848
bytes object. If ``nbytes`` is not specified then the method reads
4949
all available bytes from the serial device.
50-
USB_VCP stream implicitly works in non-blocking mode,
50+
USB_VCP `stream` implicitly works in non-blocking mode,
5151
so if no pending data available, this method will return immediately
5252
with ``None`` value.
5353

docs/library/sys.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,15 @@ Constants
104104

105105
.. data:: stderr
106106

107-
Standard error stream.
107+
Standard error `stream`.
108108

109109
.. data:: stdin
110110

111-
Standard input stream.
111+
Standard input `stream`.
112112

113113
.. data:: stdout
114114

115-
Standard output stream.
115+
Standard output `stream`.
116116

117117
.. data:: version
118118

docs/library/uio.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
|see_cpython_module| :mod:`python:io`.
88

9-
This module contains additional types of stream (file-like) objects
9+
This module contains additional types of `stream` (file-like) objects
1010
and helper functions.
1111

1212
Conceptual hierarchy

docs/library/uos.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Functions
9191

9292
.. function:: dupterm(stream_object, index=0)
9393

94-
Duplicate or switch the MicroPython terminal (the REPL) on the given stream-like
94+
Duplicate or switch the MicroPython terminal (the REPL) on the given `stream`-like
9595
object. The *stream_object* argument must implement the ``readinto()`` and
9696
``write()`` methods. The stream should be in non-blocking mode and
9797
``readinto()`` should return ``None`` if there is no data available for reading.

docs/library/uselect.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
|see_cpython_module| :mod:`python:select`.
88

99
This module provides functions to efficiently wait for events on multiple
10-
streams (select streams which are ready for operations).
10+
`streams <stream>` (select streams which are ready for operations).
1111

1212
Functions
1313
---------
@@ -33,7 +33,7 @@ Methods
3333

3434
.. method:: poll.register(obj[, eventmask])
3535

36-
Register *obj* for polling. *eventmask* is logical OR of:
36+
Register `stream` *obj* for polling. *eventmask* is logical OR of:
3737

3838
* `uselect.POLLIN` - data available for reading
3939
* `uselect.POLLOUT` - more data can be written

docs/library/usocket.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This module provides access to the BSD socket interface.
1212
.. admonition:: Difference to CPython
1313
:class: attention
1414

15-
For efficiency and consistency, socket objects in MicroPython implement a stream
15+
For efficiency and consistency, socket objects in MicroPython implement a `stream`
1616
(file-like) interface directly. In CPython, you need to convert a socket to
1717
a file-like object using `makefile()` method. This method is still supported
1818
by MicroPython (but is a no-op), so where compatibility with CPython matters,
@@ -248,7 +248,7 @@ Methods
248248
Not every `MicroPython port` supports this method. A more portable and
249249
generic solution is to use `uselect.poll` object. This allows to wait on
250250
multiple objects at the same time (and not just on sockets, but on generic
251-
stream objects which support polling). Example::
251+
`stream` objects which support polling). Example::
252252

253253
# Instead of:
254254
s.settimeout(1.0) # time in seconds

docs/library/ussl.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Functions
1515

1616
.. function:: ussl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
1717

18-
Takes a stream *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
18+
Takes a `stream` *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
1919
and returns an instance of ssl.SSLSocket, which wraps the underlying stream in
20-
an SSL context. Returned object has the usual stream interface methods like
20+
an SSL context. Returned object has the usual `stream` interface methods like
2121
`read()`, `write()`, etc. In MicroPython, the returned object does not expose
2222
socket interface and methods like `recv()`, `send()`. In particular, a
2323
server-side SSL socket should be created from a normal socket returned from

0 commit comments

Comments
 (0)