Skip to content

Commit f55f5c5

Browse files
docs: Add spi.read() second argument.
1 parent 2093bbb commit f55f5c5

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/spi.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,10 @@ Functions
5353
The ``sclk``, ``mosi`` and ``miso`` arguments specify the pins to use for
5454
each type of signal.
5555

56-
.. method:: spi.read(nbytes)
56+
.. method:: spi.read(nbytes, out=0)
5757

58-
Read at most ``nbytes``. Returns what was read.
58+
Read at most ``nbytes`` while continuously writing the single byte given by
59+
``out``. Returns what was read.
5960

6061
.. method:: spi.write(buffer)
6162

0 commit comments

Comments
 (0)