Skip to content

Commit

Permalink
Document parameter "data" of i2c.mem_read() more clear
Browse files Browse the repository at this point in the history
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
  • Loading branch information
mattthias authored and dpgeorge committed Nov 15, 2014
1 parent 4df85e4 commit ca0b0cb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/library/pyb.I2C.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Methods

Read from the memory of an I2C device:

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

0 comments on commit ca0b0cb

Please sign in to comment.