Skip to content

Fix Issue 40: Docs rendering improperly for keys function #43

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.

Sign up for GitHub

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 3 commits into from
Sep 15, 2022
Merged

Fix Issue 40: Docs rendering improperly for keys function #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72ad9d7
Update gitignore to also include .venv for virtual envs
prcutler Sep 15, 2022
57715f0
Fix issue #40 - docs rendering improperly for keys function
prcutler Sep 15, 2022
317f565
Update fix for issue #40 with Alec's feedback
prcutler Sep 15, 2022
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ _build

# Virtual environment-specific files
.env
.venv

# MacOS-specific files
*.DS_Store
Expand Down
6 changes: 3 additions & 3 deletions adafruit_macropad.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,9 +397,9 @@ def keys(self) -> Keys:
* ``key_number``: the number of the key that changed. Keys are numbered starting at 0.
* ``pressed``: ``True`` if the event is a transition from released to pressed.
* ``released``: ``True`` if the event is a transition from pressed to released.
``released`` is always the opposite of ``pressed``; it's provided
for convenience and clarity, in case you want to test for
key-release events explicitly.

``released`` is always the opposite of ``pressed``; it's provided for convenience
and clarity, in case you want to test for key-release events explicitly.

The following example prints the key press and release events to the serial console.

Expand Down