Skip to content

Commit ca0b0cb

Browse files
mattthiasdpgeorge
mattthias
authored and
dpgeorge
committed
Document parameter "data" of i2c.mem_read() more clear
Hi, i would like to add a little clarification to the parameter "data" of i2c.mem_read(): I misunderstood ``data`` can be an integer or a buffer to read into as "i can give a integer variable to read a integer into" . This pull-request adds the following clarification: ``data`` can be an integer (number of bytes to read) or a buffer to read into Thanks for your great work! Best wishes, Matthias
1 parent 4df85e4 commit ca0b0cb

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎docs/library/pyb.I2C.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Methods
9191

9292
Read from the memory of an I2C device:
9393

94-
- ``data`` can be an integer or a buffer to read into
94+
- ``data`` can be an integer (number of bytes to read) or a buffer to read into
9595
- ``addr`` is the I2C device address
9696
- ``memaddr`` is the memory location within the I2C device
9797
- ``timeout`` is the timeout in milliseconds to wait for the read

0 commit comments

Comments
 (0)