summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/machine.SPI.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 01:33:49 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 01:33:49 +0300
commit7d7243f44c68c5c1bfeba160a1650174c744722f (patch)
treebec296a71da5412f7e74ad06de8709696b027422 /docs/library/machine.SPI.rst
parent93968bd6fb15d1d49e0c2e4a2d412250cc653057 (diff)
downloadmicropython-7d7243f44c68c5c1bfeba160a1650174c744722f.tar.gz
micropython-7d7243f44c68c5c1bfeba160a1650174c744722f.zip
docs/machine.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class name.
Diffstat (limited to 'docs/library/machine.SPI.rst')
-rw-r--r--docs/library/machine.SPI.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/library/machine.SPI.rst b/docs/library/machine.SPI.rst
index 285cd37b4b..8e66660768 100644
--- a/docs/library/machine.SPI.rst
+++ b/docs/library/machine.SPI.rst
@@ -35,7 +35,7 @@ Constructors
Methods
-------
-.. method:: spi.init(mode, baudrate=1000000, \*, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, pins=(CLK, MOSI, MISO))
+.. method:: SPI.init(mode, baudrate=1000000, \*, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, pins=(CLK, MOSI, MISO))
Initialise the SPI bus with the given parameters:
@@ -48,27 +48,27 @@ Methods
- ``firstbit`` can be ``SPI.MSB`` only.
- ``pins`` is an optional tupple with the pins to assign to the SPI bus.
-.. method:: spi.deinit()
+.. method:: SPI.deinit()
Turn off the SPI bus.
-.. method:: spi.write(buf)
+.. method:: SPI.write(buf)
Write the data contained in ``buf``.
Returns the number of bytes written.
-.. method:: spi.read(nbytes, *, write=0x00)
+.. method:: SPI.read(nbytes, *, write=0x00)
Read the ``nbytes`` while writing the data specified by ``write``.
Return the number of bytes read.
-.. method:: spi.readinto(buf, *, write=0x00)
+.. method:: SPI.readinto(buf, *, write=0x00)
Read into the buffer specified by ``buf`` while writing the data specified by
``write``.
Return the number of bytes read.
-.. method:: spi.write_readinto(write_buf, read_buf)
+.. method:: SPI.write_readinto(write_buf, read_buf)
Write from ``write_buf`` and read into ``read_buf``. Both buffers must have the
same length.