lint-hotkeys/symbols: Add direction symbols to hotkeys doc.

Append arrow keys to direction key names.

Fixes #945

Author: Niloth-p

docs/hotkeys.md

@@ -17,10 +17,10 @@
 ## Navigation
 |Command|Key Combination|
 | :--- | :---: |
-|Go up / Previous message|<kbd>Up</kbd> / <kbd>K</kbd>|
-|Go down / Next message|<kbd>Down</kbd> / <kbd>J</kbd>|
-|Go left|<kbd>Left</kbd> / <kbd>H</kbd>|
-|Go right|<kbd>Right</kbd> / <kbd>L</kbd>|
+|Go up / Previous message|<kbd>Up↑</kbd> / <kbd>K</kbd>|
+|Go down / Next message|<kbd>Down↓</kbd> / <kbd>J</kbd>|
+|Go left|<kbd>Left←</kbd> / <kbd>H</kbd>|
+|Go right|<kbd>Right→</kbd> / <kbd>L</kbd>|
 |Scroll up|<kbd>PgUp</kbd> / <kbd>Shift</kbd> + <kbd>K</kbd>|
 |Scroll down|<kbd>PgDn</kbd> / <kbd>Shift</kbd> + <kbd>J</kbd>|
 |Go to bottom / Last message|<kbd>End</kbd> / <kbd>Shift</kbd> + <kbd>G</kbd>|
@@ -95,7 +95,7 @@
 |Cut backwards to the start of the current word|<kbd>Ctrl</kbd> + <kbd>W</kbd>|
 |Paste last cut section|<kbd>Ctrl</kbd> + <kbd>Y</kbd>|
 |Undo last action|<kbd>Ctrl</kbd> + <kbd>_</kbd>|
-|Jump to the previous line|<kbd>Up</kbd> / <kbd>Ctrl</kbd> + <kbd>P</kbd>|
-|Jump to the next line|<kbd>Down</kbd> / <kbd>Ctrl</kbd> + <kbd>N</kbd>|
+|Jump to the previous line|<kbd>Up↑</kbd> / <kbd>Ctrl</kbd> + <kbd>P</kbd>|
+|Jump to the next line|<kbd>Down↓</kbd> / <kbd>Ctrl</kbd> + <kbd>N</kbd>|
 |Clear compose box|<kbd>Ctrl</kbd> + <kbd>L</kbd>|
 

tools/lint-hotkeys

@@ -11,6 +11,7 @@ from zulipterminal.config.keys import (
     KEY_BINDINGS,
     display_keys_for_command,
 )
+from zulipterminal.config.symbols import DOWN_ARROW, LEFT_ARROW, RIGHT_ARROW, UP_ARROW
 
 
 KEYS_FILE = (
@@ -89,6 +90,14 @@ def generate_hotkeys_file() -> None:
     print(f"Hot Keys list saved in {OUTPUT_FILE}")
 
 
+DIRECTION_TO_SYMBOL_MAP = {
+    "Up": UP_ARROW,
+    "Down": DOWN_ARROW,
+    "Left": LEFT_ARROW,
+    "Right": RIGHT_ARROW,
+}
+
+
 def get_hotkeys_file_string() -> str:
     """
     Construct string in form for output to OUTPUT_FILE based on help text
@@ -114,7 +123,7 @@ def get_hotkeys_file_string() -> str:
                             if len(key) == 1 and key.isupper()
                             else f"<kbd>{key.capitalize()}</kbd>"
                             if len(key) == 1
-                            else f"<kbd>{key}</kbd>"
+                            else f"<kbd>{key + DIRECTION_TO_SYMBOL_MAP.get(key, '')}</kbd>"
                             for key in key_combination.split()
                         ]
                     )

zulipterminal/config/symbols.py

@@ -86,3 +86,8 @@
     bline=_MESSAGE_RECIPIENTS_BOTTOM,
     brcorner=_MESSAGE_RECIPIENTS_BOTTOM,
 )
+
+LEFT_ARROW = "←"  # LEFTWARDS ARROW, U+2190
+UP_ARROW = "↑"  # UPWARDS ARROW, U+2191
+RIGHT_ARROW = "→"  # RIGHTWARDS ARROW, U+2192
+DOWN_ARROW = "↓"  # DOWNWARDS ARROW, U+2193