djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document parameter "data" of i2c.mem_read() more clear

Browse Source 
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
This commit is contained in:
Matthias 2014-11-12 23:59:40 +01:00 committed by Damien George
parent 4df85e49d4
commit ca0b0cb83f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/library/pyb.I2C.rst
View File

@ -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