docs: Add spi.read() second argument.

bbcmicrobit · May 2, 2024 · f55f5c5 · f55f5c5
1 parent 2093bbb
commit f55f5c5
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/spi.rst b/docs/spi.rst
@@ -53,9 +53,10 @@ Functions
     The ``sclk``, ``mosi`` and ``miso`` arguments specify the pins to use for
     each type of signal.
 
-.. method:: spi.read(nbytes)
+.. method:: spi.read(nbytes, out=0)
 
-   Read at most ``nbytes``. Returns what was read.
+   Read at most ``nbytes`` while continuously writing the single byte given by
+   ``out``. Returns what was read.
 
 .. method:: spi.write(buffer)