Added readinto() method to be more consistant with busdevice.spi. #10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ed warning on read_into() saying it will be deprecated in the future
tannewt
requested changes
Nov 3, 2017
adafruit_bus_device/i2c_device.py
Outdated
| def read_into(self, buf, **kwargs): | ||
| """ | ||
| Warning: This method will be deprecated some time in the future. | ||
| Please start using readinto() instead. readinto() is functionally |
There was a problem hiding this comment.
Please use backticks around readinto so that sphinx makes it clickable. You can also use .. warning:: to make it called out in a box. http://www.sphinx-doc.org/en/stable/rest.html#directives
|
Scott, i hope this is what you want. |
tannewt
approved these changes
Nov 5, 2017
tannewt
added a commit
to adafruit/adabot
that referenced
this pull request
Nov 21, 2017
Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 0.1.0 from e731810: > fix .travis.yml > add .travis.yml and .gitignore; I2C.read_into -> readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_BME280 to 2.0 from 1.0.0: > Update travis config to use 2.x branch for MPY generation. > changed read_into to readinto > Merge pull request adafruit/Adafruit_CircuitPython_BME280#1 from chickadee-tech/doc_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_BME680 to 2.0.1 from f1e5aa2: > Ensure gas property updates reading state. > rename fix > Update travis config with 2.x branch MPY generation. > changed read_into to readinto > Merge pull request adafruit/Adafruit_CircuitPython_BME680#1 from chickadee-tech/doc_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_BMP280 to 2.0 from 1.0.0: > Update travis to use 2.x branch for MPY generation. > changed read_into to readinto > Merge pull request adafruit/Adafruit_CircuitPython_BMP280#2 from chickadee-tech/doc_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO055 to 2.0 from 0.1.3: > Switch to 2.x branch for MPY generation. > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_CCS811 to 0.0.2 from 0.0.1: > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_DS3231 to 2.0.1 from 1.0.0: > changed read_into to readinto > Add demo example based on PCF8523 guide. > Switch to build from circuitpython 2.x branch mpy-cross Updating https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH to 0.1.3 from 0.1.2: > busdevice method changed from read_into() to readinto() > Optimize the way data in unpacked (adafruit/Adafruit_CircuitPython_LIS3DH#9) > added ImportError to except > changed to use struct module instead of ustruct (adafruit/Adafruit_CircuitPython_LIS3DH#6) > Update to upcoming NeoPixel API Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX31855 to 2.0 from 0.1.1: > Update .travis.yml > changed conditional import for struct and ustruct (adafruit/Adafruit_CircuitPython_MAX31855#2) Updating https://github.com/adafruit/Adafruit_CircuitPython_MCP9808 to 2.0 from 0.1.1: > Update .travis.yml > changed read_into to readinto > Clarify code indents (adafruit/Adafruit_CircuitPython_MCP9808#2) > Minor tidying Updating https://github.com/adafruit/Adafruit_CircuitPython_MPR121 to 0.1.2 from 0.1.1: > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_PCF8523 to 0.1.1 from 0.1.0: > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_SI7021 to 2.0 from 0.1.4: > Switch travis config to build from 2.0 circuitpython branch. > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_TSL2561 to 2.0 from 51b7cd9: > Update travis config to use 2.x branch for MPY generation. > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#6 from caternuson/master > fix deploy filename > Correct the docs badge > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#3 from caternuson/master > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#2 from caternuson/iss001 Updating https://github.com/adafruit/Adafruit_CircuitPython_VC0706 to 2.0 from 286bd31: < Add example with internal filesystem write. Updating https://github.com/adafruit/Adafruit_CircuitPython_BusDevice to 2.0.1 from 0.3.1: > remove deprecated method read_into > Added readinto() method to be more consistant with busdevice.spi. (adafruit/Adafruit_CircuitPython_BusDevice#10) Updating https://github.com/adafruit/Adafruit_CircuitPython_Register to 1.0.3 from 1.0.2: > changed read_into to readinto to follow changes in Adafruit_CircuitPython_BusDevice (adafruit/Adafruit_CircuitPython_Register#6)
tannewt
pushed a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Nov 21, 2017
Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 0.1.0 from e731810: > fix .travis.yml > add .travis.yml and .gitignore; I2C.read_into -> readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_BME280 to 2.0 from 1.0.0: > Update travis config to use 2.x branch for MPY generation. > changed read_into to readinto > Merge pull request adafruit/Adafruit_CircuitPython_BME280#1 from chickadee-tech/doc_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_BME680 to 2.0.1 from f1e5aa2: > Ensure gas property updates reading state. > rename fix > Update travis config with 2.x branch MPY generation. > changed read_into to readinto > Merge pull request adafruit/Adafruit_CircuitPython_BME680#1 from chickadee-tech/doc_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_BMP280 to 2.0 from 1.0.0: > Update travis to use 2.x branch for MPY generation. > changed read_into to readinto > Merge pull request adafruit/Adafruit_CircuitPython_BMP280#2 from chickadee-tech/doc_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO055 to 2.0 from 0.1.3: > Switch to 2.x branch for MPY generation. > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_CCS811 to 0.0.2 from 0.0.1: > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_DS3231 to 2.0.1 from 1.0.0: > changed read_into to readinto > Add demo example based on PCF8523 guide. > Switch to build from circuitpython 2.x branch mpy-cross Updating https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH to 0.1.3 from 0.1.2: > busdevice method changed from read_into() to readinto() > Optimize the way data in unpacked (adafruit/Adafruit_CircuitPython_LIS3DH#9) > added ImportError to except > changed to use struct module instead of ustruct (adafruit/Adafruit_CircuitPython_LIS3DH#6) > Update to upcoming NeoPixel API Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX31855 to 2.0 from 0.1.1: > Update .travis.yml > changed conditional import for struct and ustruct (adafruit/Adafruit_CircuitPython_MAX31855#2) Updating https://github.com/adafruit/Adafruit_CircuitPython_MCP9808 to 2.0 from 0.1.1: > Update .travis.yml > changed read_into to readinto > Clarify code indents (adafruit/Adafruit_CircuitPython_MCP9808#2) > Minor tidying Updating https://github.com/adafruit/Adafruit_CircuitPython_MPR121 to 0.1.2 from 0.1.1: > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_PCF8523 to 0.1.1 from 0.1.0: > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_SI7021 to 2.0 from 0.1.4: > Switch travis config to build from 2.0 circuitpython branch. > changed read_into to readinto Updating https://github.com/adafruit/Adafruit_CircuitPython_TSL2561 to 2.0 from 51b7cd9: > Update travis config to use 2.x branch for MPY generation. > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#6 from caternuson/master > fix deploy filename > Correct the docs badge > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#3 from caternuson/master > Merge pull request adafruit/Adafruit_CircuitPython_TSL2561#2 from caternuson/iss001 Updating https://github.com/adafruit/Adafruit_CircuitPython_VC0706 to 2.0 from 286bd31: < Add example with internal filesystem write. Updating https://github.com/adafruit/Adafruit_CircuitPython_BusDevice to 2.0.1 from 0.3.1: > remove deprecated method read_into > Added readinto() method to be more consistant with busdevice.spi. (adafruit/Adafruit_CircuitPython_BusDevice#10) Updating https://github.com/adafruit/Adafruit_CircuitPython_Register to 1.0.3 from 1.0.2: > changed read_into to readinto to follow changes in Adafruit_CircuitPython_BusDevice (adafruit/Adafruit_CircuitPython_Register#6)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added warning on read_into() saying it will be deprecated in the future.
I2C & SPI BusDevice readinto/read_into Issue #364
First step is to get this change into the master then start changing libraries that make calls to read_into()