diff options
| author | Zenix27 <30363000+Zenix27@users.noreply.github.com> | 2020-07-11 12:23:26 +0530 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2020-08-21 12:24:13 +1000 |
| commit | e76c7466b62c940150cf1b5000e18f60a5efa2e3 (patch) | |
| tree | 0ced7b7a5eb3f5efb6524ca1cf65bd0188b57bc5 /docs/library/pyb.SPI.rst | |
| parent | 17689a71f66bcf96c09f8700fa3e0f5aa5be225c (diff) | |
docs: Change `\*` to `*` in argument lists.
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and
will render the `\` in the output if it is there, so remove it.
Fixes issue #6209.
Diffstat (limited to 'docs/library/pyb.SPI.rst')
| -rw-r--r-- | docs/library/pyb.SPI.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/library/pyb.SPI.rst b/docs/library/pyb.SPI.rst index 181bdd3b6..24e2ec5a7 100644 --- a/docs/library/pyb.SPI.rst +++ b/docs/library/pyb.SPI.rst @@ -51,7 +51,7 @@ Methods Turn off the SPI bus. -.. 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: @@ -77,7 +77,7 @@ Methods Printing the SPI object will show you the computed baudrate and the chosen prescaler. -.. method:: SPI.recv(recv, \*, timeout=5000) +.. method:: SPI.recv(recv, *, timeout=5000) Receive data on the bus: @@ -88,7 +88,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: @@ -97,7 +97,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: |