summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.SPI.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 16:21:28 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 16:21:28 +0300
commita384a5313013d8ffda4db0e509cf798a080b3526 (patch)
treec1b87be77f0a3a68fc5a55880bf9de8af3b90b87 /docs/library/pyb.SPI.rst
parent585aafc27eb7fa8fe660e3eeaa29bf8d7ab99213 (diff)
downloadmicropython-a384a5313013d8ffda4db0e509cf798a080b3526.tar.gz
micropython-a384a5313013d8ffda4db0e509cf798a080b3526.zip
docs/pyb.*: 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/pyb.SPI.rst')
-rw-r--r--docs/library/pyb.SPI.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/library/pyb.SPI.rst b/docs/library/pyb.SPI.rst
index 0b5546513b..54ecc65b6d 100644
--- a/docs/library/pyb.SPI.rst
+++ b/docs/library/pyb.SPI.rst
@@ -51,13 +51,13 @@ Constructors
Methods
-------
-.. method:: spi.deinit()
+.. method:: SPI.deinit()
Turn off the SPI bus.
.. only:: port_pyboard
- .. method:: spi.init(mode, baudrate=328125, \*, prescaler, polarity=1, phase=0, bits=8, firstbit=SPI.MSB, ti=False, crc=None)
+ .. method:: SPI.init(mode, baudrate=328125, \*, prescaler, polarity=1, phase=0, bits=8, firstbit=SPI.MSB, ti=False, crc=None)
Initialise the SPI bus with the given parameters:
@@ -83,7 +83,7 @@ Methods
.. only:: port_pyboard
- .. method:: spi.recv(recv, \*, timeout=5000)
+ .. method:: SPI.recv(recv, \*, timeout=5000)
Receive data on the bus:
@@ -94,7 +94,7 @@ Methods
Return value: if ``recv`` is an integer then a new buffer of the bytes received,
otherwise the same buffer that was passed in to ``recv``.
- .. method:: spi.send(send, \*, timeout=5000)
+ .. method:: SPI.send(send, \*, timeout=5000)
Send data on the bus:
@@ -103,7 +103,7 @@ Methods
Return value: ``None``.
- .. method:: spi.send_recv(send, recv=None, \*, timeout=5000)
+ .. method:: SPI.send_recv(send, recv=None, \*, timeout=5000)
Send and receive data on the bus at the same time: