update hotkey comments

koddsson · koddsson · commit 52ea704056dc · 2019-01-18T14:34:53.000Z
diff --git a/src/hotkey.js b/src/hotkey.js
@@ -1,26 +1,29 @@
 /* @flow strict */
 
-// Returns a hotkey character string for keydown and keyup events.
+// # Returns a hotkey character string for keydown and keyup events.
 //
 // A full list of key names can be found here:
 // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
 //
-// Examples
+// ## Code Example
 //
+// ```
 //   document.addEventListener('keydown', function(event) {
 //     if (hotkey(event) === 'h') ...
 //   })
+// ```
+// ## Hotkey examples
 //
-// "s" // Lowercase character for single letters
-// "S" // Uppercase character for shift plus a letter
-// "1" // Number character
-// "?" // Shift plus "/" symbol
+// "s"                  // Lowercase character for single letters
+// "S"                  // Uppercase character for shift plus a letter
+// "1"                  // Number character
+// "?"                  // Shift plus "/" symbol
 //
-// "Enter" // Enter key
-// "ArrowUp"    // Up arrow
+// "Enter"              // Enter key
+// "ArrowUp"            // Up arrow
 //
 // "Control+s"          // Control modifier plus letter
-// "Control+Alt+Delete" // Multiple modifiers plus letter
+// "Control+Alt+Delete" // Multiple modifiers
 //
 // Returns key character String or null.
 export default function hotkey(event: KeyboardEvent) {
