update docs for mode

myk002 · myk002 · commit bcab483b57dc · 2022-07-28T02:50:37.000-07:00
diff --git a/docs/plugins/mode.rst b/docs/plugins/mode.rst
@@ -1,5 +1,8 @@
 mode
 ====
+Tags:
+:dfhack-keybind:`mode`
+
 This command lets you see and change the game mode directly.
 
 .. warning::
@@ -9,13 +12,27 @@ This command lets you see and change the game mode directly.
     Not all combinations are good for every situation and most of them will
     produce undesirable results. There are a few good ones though.
 
-Examples:
+Usage:
+
+``mode``
+    Print the current game mode.
+``mode set``
+    Enter an interactive commandline menu where you can set the game mode.
+
+Examples
+--------
+
+Scenario 1:
+
+* You are in fort game mode, managing your fortress and paused.
+* You switch to the arena game mode, *assume control of a creature* and then
+* switch to adventure game mode.
+
+You just lost a fortress and gained an adventurer.
+
+Scenario 2:
 
-  * You are in fort game mode, managing your fortress and paused.
-  * You switch to the arena game mode, *assume control of a creature* and then
-  * switch to adventure game mode(1).
-    You just lost a fortress and gained an adventurer.  Alternatively:
+* You are in fort game mode, managing your fortress and paused at the Esc menu.
+* You switch to the adventure game mode, assume control of a creature, then save or retire.
 
-  * You are in fort game mode, managing your fortress and paused at the esc menu.
-  * You switch to the adventure game mode, assume control of a creature, then save or retire.
-  * You just created a returnable mountain home and gained an adventurer.
+You just created a returnable mountain home and gained an adventurer.
diff --git a/plugins/mode.cpp b/plugins/mode.cpp
@@ -19,12 +19,10 @@ DFHACK_PLUGIN("mode");
 DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
 {
     commands.push_back(PluginCommand(
-        "mode","View, change and track game mode.",
-        mode, true,
-        "  Without any parameters, this command prints the current game mode\n"
-        "  You can interactively set the game mode with 'mode set'.\n"
-        "!!Setting the game modes can be dangerous and break your game!!\n"
-    ));
+        "mode",
+        "View, change and track game mode.",
+        mode,
+        true));
     return CR_OK;
 }
 
