Update documentation for AddShortcut

Closes #80
dail8859 · Apr 7, 2020 · 7c425ea · 7c425ea
1 parent 8d47923
commit 7c425ea
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/classes/Notepad.html b/docs/classes/Notepad.html
@@ -547,7 +547,7 @@ <h3>Parameters:</h3>
         </li>
         <li><span class="parameter">shortcut</span>
             <span class="types"><span class="type">string</span></span>
-         the modifier and key (e.g. "Ctrl+Alt+Shift+D"). The key must be A-Z, 0-9, or F1-F12
+         the modifier and key (e.g. "<code>Ctrl+Alt+Shift+D</code>"). The <em>key</em> must be one of: <code>A</code>-<code>Z</code>, <code>0</code>-<code>9</code>, <code>F1</code>-<code>F12</code>, <code>;</code>, <code>/</code>, <code>~</code>, <code>[</code>, <code>\</code>, <code>]</code>, <code>\</code>, <code>,</code>, <code>-</code>, <code>.</code>, <code>=</code>, <code>up</code>, <code>down</code>, <code>left</code>, <code>right</code>, <code>space</code>, <code>pageup</code>, <code>pagedown</code>, <code>backspace</code>, <code>delete</code>, <code>escape</code>
         </li>
         <li><span class="parameter">callback</span>
             <span class="types"><span class="type">function</span></span>

diff --git a/docs_gen/Notepad.lua b/docs_gen/Notepad.lua
@@ -318,7 +318,7 @@
 -- @function AddShortcut
 -- @static
 -- @tparam string name the user-friendly name of the shortcut (this is displayed in the menu)
--- @tparam string shortcut the modifier and key (e.g. "Ctrl+Alt+Shift+D"). The key must be A-Z, 0-9, or F1-F12
+-- @tparam string shortcut the modifier and key (e.g. "`Ctrl+Alt+Shift+D`"). The _key_ must be one of: `A`-`Z`, `0`-`9`, `F1`-`F12`, `;`, `/`, `~`, `[`, `\`, `]`, `\`, `,`, `-`, `.`, `=`, `up`, `down`, `left`, `right`, `space`, `pageup`, `pagedown`, `backspace`, `delete`, `escape`
 -- @tparam function callback function to call when the shortcut is triggered
 
 --- Writes an error message to the console.