diff --git a/docs/extension_stringy_keymaps.md b/docs/extension_stringy_keymaps.md index 9a6ea97..ae5e135 100644 --- a/docs/extension_stringy_keymaps.md +++ b/docs/extension_stringy_keymaps.md @@ -5,7 +5,7 @@ Enables referring to keys by `'NAME'` rather than `KC.NAME`. For example: ```python -from kmk.extensions.stringy_keymaps import Stringy_keymaps +from kmk.extensions.stringy_keymaps import StringyKeymaps # Normal # keyboard.keymap = [[ KC.A, KC.B, KC.RESET ]] @@ -16,13 +16,13 @@ from kmk.extensions.stringy_keymaps import Stringy_keymaps # String names keyboard.keymap = [[ 'A' , 'B', 'RESET' ]] -stringy_keymaps = Stringy_keymaps() +stringyKeymaps = StringyKeymaps() # Enabling debug will show each replacement or failure. # This is recommended during the initial development of a keyboard. -# stringy_keymaps.debug_enable = True +# stringyKeymaps.debug_enable = True -keyboard.extensions.append(stringy_keymaps) +keyboard.extensions.append(stringyKeymaps) ``` It should be noted that these are **not** ASCII. The string is **not** what diff --git a/docs/extensions.md b/docs/extensions.md index 711a068..6bd6f84 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -16,4 +16,4 @@ extensions are - [RGB](rgb.md): RGB lighting for underglow. Will work on most matrix RGB as will be treated the same as underglow. - [Status LED](extension_statusled.md): Indicates which layer you are on with an array of single leds. -- [Stringy Keymaps](extension_stringy_keymaps): Enables referring to keys by 'NAME' rather than KC.NAME +- [Stringy Keymaps](extension_stringy_keymaps): Enables referring to keys by `'NAME'` rather than `KC.NAME` diff --git a/kmk/extensions/stringy_keymaps.py b/kmk/extensions/stringy_keymaps.py index 792746d..a2b1ef7 100644 --- a/kmk/extensions/stringy_keymaps.py +++ b/kmk/extensions/stringy_keymaps.py @@ -2,7 +2,7 @@ from kmk.extensions import Extension from kmk.keys import KC -class Stringy_keymaps(Extension): +class StringyKeymaps(Extension): ##### # User-configurable debug_enabled = False diff --git a/tests/test_kmk_extension_stringy_keymaps.py b/tests/test_kmk_extension_stringy_keymaps.py index 65b85f1..125b68c 100644 --- a/tests/test_kmk_extension_stringy_keymaps.py +++ b/tests/test_kmk_extension_stringy_keymaps.py @@ -1,6 +1,6 @@ import unittest -from kmk.extensions.stringy_keymaps import Stringy_keymaps +from kmk.extensions.stringy_keymaps import StringyKeymaps from kmk.keys import KC from tests.keyboard_test import KeyboardTest @@ -8,14 +8,14 @@ from tests.keyboard_test import KeyboardTest class Test_extension_stringy_keymaps(unittest.TestCase): def test_basic_kmk_keyboard_replace_string_primary_name(self): keyboard = KeyboardTest( - [], [['1', '2', '3', '4']], extensions={Stringy_keymaps()} + [], [['1', '2', '3', '4']], extensions={StringyKeymaps()} ) keyboard.test('Simple key press', [(0, True), (0, False)], [{KC.N1}, {}]) def test_basic_kmk_keyboard_replace_string_secondary_name(self): keyboard = KeyboardTest( - [], [['N1', 'N2', 'N3', 'N4']], extensions={Stringy_keymaps()} + [], [['N1', 'N2', 'N3', 'N4']], extensions={StringyKeymaps()} ) keyboard.test('Simple key press', [(0, True), (0, False)], [{KC.N1}, {}])