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.I2C.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.I2C.rst')
| -rw-r--r-- | docs/library/pyb.I2C.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst index d549c1a81..641dcb881 100644 --- a/docs/library/pyb.I2C.rst +++ b/docs/library/pyb.I2C.rst @@ -84,7 +84,7 @@ Methods Turn off the I2C bus. -.. method:: I2C.init(mode, \*, addr=0x12, baudrate=400000, gencall=False, dma=False) +.. method:: I2C.init(mode, *, addr=0x12, baudrate=400000, gencall=False, dma=False) Initialise the I2C bus with the given parameters: @@ -100,7 +100,7 @@ Methods Check if an I2C device responds to the given address. Only valid when in master mode. -.. method:: I2C.mem_read(data, addr, memaddr, \*, timeout=5000, addr_size=8) +.. method:: I2C.mem_read(data, addr, memaddr, *, timeout=5000, addr_size=8) Read from the memory of an I2C device: @@ -113,7 +113,7 @@ Methods Returns the read data. This is only valid in master mode. -.. method:: I2C.mem_write(data, addr, memaddr, \*, timeout=5000, addr_size=8) +.. method:: I2C.mem_write(data, addr, memaddr, *, timeout=5000, addr_size=8) Write to the memory of an I2C device: @@ -126,7 +126,7 @@ Methods Returns ``None``. This is only valid in master mode. -.. method:: I2C.recv(recv, addr=0x00, \*, timeout=5000) +.. method:: I2C.recv(recv, addr=0x00, *, timeout=5000) Receive data on the bus: @@ -138,7 +138,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:: I2C.send(send, addr=0x00, \*, timeout=5000) +.. method:: I2C.send(send, addr=0x00, *, timeout=5000) Send data on the bus: |