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/machine.I2C.rst | |
| parent | 17689a71f66bcf96c09f8700fa3e0f5aa5be225c (diff) | |
| download | micropython-e76c7466b62c940150cf1b5000e18f60a5efa2e3.tar.gz micropython-e76c7466b62c940150cf1b5000e18f60a5efa2e3.zip | |
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/machine.I2C.rst')
| -rw-r--r-- | docs/library/machine.I2C.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/library/machine.I2C.rst b/docs/library/machine.I2C.rst index 2cbfec1ba8..743554bc76 100644 --- a/docs/library/machine.I2C.rst +++ b/docs/library/machine.I2C.rst @@ -33,7 +33,7 @@ Example usage:: Constructors ------------ -.. class:: I2C(id=-1, \*, scl, sda, freq=400000) +.. class:: I2C(id=-1, *, scl, sda, freq=400000) Construct and return a new I2C object using the following parameters: @@ -52,7 +52,7 @@ Constructors General Methods --------------- -.. method:: I2C.init(scl, sda, \*, freq=400000) +.. method:: I2C.init(scl, sda, *, freq=400000) Initialise the I2C bus with the given arguments: @@ -153,14 +153,14 @@ from and written to. In this case there are two addresses associated with an I2C transaction: the slave address and the memory address. The following methods are convenience functions to communicate with such devices. -.. method:: I2C.readfrom_mem(addr, memaddr, nbytes, \*, addrsize=8) +.. method:: I2C.readfrom_mem(addr, memaddr, nbytes, *, addrsize=8) Read *nbytes* from the slave specified by *addr* starting from the memory address specified by *memaddr*. The argument *addrsize* specifies the address size in bits. Returns a `bytes` object with the data read. -.. method:: I2C.readfrom_mem_into(addr, memaddr, buf, \*, addrsize=8) +.. method:: I2C.readfrom_mem_into(addr, memaddr, buf, *, addrsize=8) Read into *buf* from the slave specified by *addr* starting from the memory address specified by *memaddr*. The number of bytes read is the @@ -170,7 +170,7 @@ methods are convenience functions to communicate with such devices. The method returns ``None``. -.. method:: I2C.writeto_mem(addr, memaddr, buf, \*, addrsize=8) +.. method:: I2C.writeto_mem(addr, memaddr, buf, *, addrsize=8) Write *buf* to the slave specified by *addr* starting from the memory address specified by *memaddr*. |