summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/machine.I2C.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/machine.I2C.rst')
-rw-r--r--docs/library/machine.I2C.rst10
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*.