diff options
| author | Matthias <matthias@sigxcpu.org> | 2014-11-12 23:59:40 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-11-15 18:31:37 +0000 |
| commit | ca0b0cb83f55afddc0b8055f6283dc13f7cafdc6 (patch) | |
| tree | 12ba45fc5206569c76a7ae49cf2d6f6b75e7c746 | |
| parent | 4df85e49d48a76246d97383ac6a5d63e1ce2be60 (diff) | |
| download | micropython-ca0b0cb83f55afddc0b8055f6283dc13f7cafdc6.tar.gz micropython-ca0b0cb83f55afddc0b8055f6283dc13f7cafdc6.zip | |
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
| -rw-r--r-- | docs/library/pyb.I2C.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst index 1eb426168c..e40684a78a 100644 --- a/docs/library/pyb.I2C.rst +++ b/docs/library/pyb.I2C.rst @@ -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 |