Skip to content

Update readme and docstring with new function name #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ This example displays sensor and input data on the CLUE display.

clue.sea_level_pressure = 1020

clue_data = clue.display_clue_data(title="CLUE Sensor Data!", title_scale=2, num_lines=15)
clue_data = clue.simple_text_display(title="CLUE Sensor Data!", title_scale=2, num_lines=15)

while True:
clue_data[0].text = "Acceleration: {:.2f} {:.2f} {:.2f}".format(*clue.acceleration)
Expand Down
2 changes: 1 addition & 1 deletion adafruit_clue.py
Original file line number Diff line number Diff line change
Expand Up @@ -869,7 +869,7 @@ def simple_text_display(title=None, title_color=(255, 255, 255), title_scale=1,

Setup occurs before the loop. For data to be dynamically updated on the display, you must
include the data call in the loop by using ``.text =``. For example, if setup is saved as
``clue_data = display_clue_data()`` then ``clue_data[0].text = clue.proximity`` must be
``clue_data = simple_text_display()`` then ``clue_data[0].text = clue.proximity`` must be
inside the ``while True:`` loop for the proximity data displayed to update as the
values change. You must call ``show()`` at the end of the list for anything to display.
See example below for usage.
Expand Down