adafruit / Adafruit_CircuitPython_24LC32

CircuitPython Driver for Adafruit 24LC32 I2C EEPROM Breakout 32Kbit / 4 KB
MIT License
6 stars 6 forks source link

import in code example in documentation is wrong #16

Closed muranyia closed 2 years ago

muranyia commented 2 years ago

In the online docs this part of the code doesn't work:

import adafruit_eeprom

i2c = board.I2C()
eeprom = adafruit_eeprom.EEPROM_I2C(i2c)

changing it like this makes it work:

import adafruit_24lc32

i2c = board.I2C()
eeprom = adafruit_24lc32.EEPROM_I2C(i2c)

(If documentation bugs are to be submitted elsewhere, please advise me. Thanks.)

FoamyGuy commented 2 years ago

Thanks for reporting. Are you interested in submitting a PR to change it?

muranyia commented 2 years ago

I'd love to, but the bug is not present here. Is there a separate repo where docs.circuitpython.org pulls from, or they haven't updated their content?

FoamyGuy commented 2 years ago

@muranyia I think it gets populated from the README.rst file in this repo. Updating it inside of that file should fix it on the docs page as well.