update docs for hotkeys

2022-07-25 21:54:34 -07:00 · 2022-07-25 21:54:34 -07:00 · 69d88a62dd
parent b93e3365f6
commit 69d88a62dd
2 changed files with 13 additions and 6 deletions
--- a/docs/plugins/hotkeys.rst
+++ b/docs/plugins/hotkeys.rst
@ -1,8 +1,14 @@
 hotkeys
 =======
-Opens an in-game screen showing which DFHack keybindings are
-active in the current context.  See also `hotkey-notes`.
+Tags:
+:dfhack-keybind:`hotkeys`

-.. image:: ../images/hotkeys.png
+Show all dfhack keybindings in current context. The command opens an in-game
+screen showing which DFHack keybindings are active in the current context.
+See also `hotkey-notes`.

-:dfhack-keybind:`hotkeys`
+Usage::
+
+    hotkeys
+
+.. image:: ../images/hotkeys.png
--- a/plugins/hotkeys.cpp
+++ b/plugins/hotkeys.cpp
@ -356,8 +356,9 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug

    commands.push_back(
        PluginCommand(
-        "hotkeys", "Show all dfhack keybindings in current context.",
-        hotkeys_cmd, false, ""));
+        "hotkeys",
+        "Show all dfhack keybindings in current context.",
+        hotkeys_cmd));

    return CR_OK;
 }