Merge pull request #43 from prcutler/issue40

Fix Issue 40: Docs rendering improperly for keys function
adafruit · Sep 15, 2022 · 96f827e · 96f827e
2 parents 5f8c103 + 317f565
commit 96f827e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -37,6 +37,7 @@ _build
 
 # Virtual environment-specific files
 .env
+.venv
 
 # MacOS-specific files
 *.DS_Store

diff --git a/adafruit_macropad.py b/adafruit_macropad.py
@@ -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.
-Original file 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 @@