add doc

Ajatt-Tools · Jun 8, 2024 · 9f9fe98 · 9f9fe98
1 parent 2963f9c
commit 9f9fe98
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/vim_shortcuts.py b/vim_shortcuts.py
@@ -87,6 +87,9 @@ def is_not_ease_key(shortcut: tuple[str, Callable]) -> bool:
 
 
 def is_key_set(shortcut: tuple[str, Callable]) -> bool:
+    """
+    First field in the tuple is a key on the keyboard.
+    """
     return bool(shortcut[0])