Add documentation for custom keys

Author: xs5871

docs/en/keys.md

@@ -4,7 +4,105 @@
 can be found in [`keycodes.md`](keycodes.md). It's probably worth a look at the raw source if
 you're stumped: [`kmk/keys.py`](/kmk/keys.py).
 
----
+## Custom Keys
+
+Here's a very contrived example for a custom key which limits the usage of a key
+to certain amount.
+Custom keys are, as a rule of thumb, the way to go to implement custom
+functionality.
+If the objective is to type out a sequence of keys however, or an action has to
+be performed asynchronously while holding a key down, then [macros](macros.md)
+are worth trading higher convenience for the hit in performance.
+
+### Quick and Dirty
+
+The base key class, of which all keys are derived, accepts custom handlers.
+It's "single use" and should cover most use cases and not recommended for stateful keys.
+Both `on_press` and `on_release` methods are optional and a custom key is
+allowed to do absolutely nothing.
+
+```python
+from kmk.keys import Key
+
+limit = 10
+
+def limit_on_press(key, keyboard, *args):
+    global limit
+    if limit > 0:
+       keyboard.add_key(KC.A)
+
+def limit_on_release(key, keyboard, *args):
+    global limit
+    if limit > 0:
+        keyboard.remove_key(KC.A)
+        limit -= 1
+
+KC_A10 = Key(on_press=limit_on_press, on_release=limit_on_release)
+```
+
+### Generally Recommended
+
+Reusable or stateful keys are better implemented as a custom key derived from
+the base class.
+Giving the key a custom type (i.e. name) can make it easier to spot in
+debug messages and opens up to possibility to react on key types in custom
+modules; the downside is a potential slight increased in memory consumption.
+All methods are technically optional, although it is recommended to implement
+them anyway or the default implementations of `Key` may look for handlers that
+don't exist.
+
+```python
+from kmk.keys import Key
+
+class LimitKey(Key):
+    def __init__(self, key, limit):
+        self.key = KC.A
+        self.limit = limit
+
+    def on_press(self, keyboard, coord_int=None):
+        if self.limit > 0:
+            keyboard.add_key(self.key)
+
+    def on_release(self, keyboard, coord_int=None):
+        if self.limit > 0:
+            self.limit -= 1
+            keyboard.remove_key(self.key)
+
+KC_A10 = LimitKey(KC.A, 10)
+KC_B20 = LimitKey(KC.B, 20)
+```
+
+### Unnecessary
+
+For completeness sake: this is how keys can be entered into the `KC` dictionary.
+There's no reason to do this as it will have a negative, if probably small
+effect on memory usage for no actual benefit.
+
+```python
+from kmk.keys import make_key
+
+# with an instance of base key class with 1 alias
+make_key(
+    names=('A10',),
+    constructor=Key,
+    on_press=limit_on_press,
+    on_release=limit_on_release,
+)
+
+# with a custom base key class with 3 aliases
+make_key(
+    names=('B20', 'LIMIT_B_20', 'B_ONLY_20_TIMES'),
+    constructor=LimitKey,
+    key=KC.B,
+    count=20,
+)
+
+# makes those keys available as:
+KC.A10
+KC.B20
+KC.LIMIT_B_20
+KC.B_ONLY_20_TIMES
+```
 
 ## Key Objects
 

docs/en/macros.md

@@ -4,6 +4,9 @@ Macros are used for sending multiple keystrokes in a single action, and can
 be used for things like Unicode characters (even emojis! 🇨🇦), _Lorem ipsum_
 generators, triggering side effects (think lighting, speakers,
 microcontroller-optimized cryptocurrency miners, whatever).
+Macros have worse performance and higher memory usage than [custom keys](keys.md),
+so unless the objective is to type out a sequence or to perform an action repeatedly
+and asynchronously while a key is pressed, custom keys are the recommended solution.
 
 ## Setup
 

util/aspell.en.pws

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 355 
+personal_ws-1.1 en 357
 ADNS
 AMS
 ANAVI
@@ -333,6 +333,8 @@ rp
 runtime
 scotto
 splitkb
+stateful
+StickyKeys
 sublicensable
 sublicenses
 subrezon