search

adafruit / Adafruit_CircuitPython_CLUE

A high-level library representing all the features of the Adafruit CLUE
MIT License
32 stars 20 forks source link

readme sample code needs updated #21

Closed FoamyGuy closed 4 years ago

FoamyGuy commented 4 years ago

The example in the readme is using this function clue.display_clue_data() but it does not seem to exist any more. This example from in the repo is essentially the same thing. It's using clue.simple_text_display() and it works correctly as far as I can tell. I can work on making a PR to change the readme to match the example script.

caternuson commented 4 years ago

Left overs from a function name change. Looks like it also shows up in doc string:

Adafruit_CircuitPython_CLUE$ grep -i -r display_clue_data
adafruit_clue.py:        ``clue_data = display_clue_data()`` then ``clue_data[0].text = clue.proximity`` must be
adafruit_clue.py:        .. image :: ../docs/_static/display_clue_data.jpg
README.rst:    clue_data = clue.display_clue_data(title="CLUE Sensor Data!", title_scale=2, num_lines=15)
FoamyGuy commented 4 years ago

25 resolves this issue