From 989befa5824bd1ef54fecb5589c933e1409fc994 Mon Sep 17 00:00:00 2001
From: myk002 <myk002@yahoo.com>
Date: Mon, 25 Jul 2022 10:22:23 -0700
Subject: [PATCH] update docs for fastdwarf

---
 docs/plugins/fastdwarf.rst | 46 ++++++++++++++++++++++++++++----------
 plugins/fastdwarf.cpp      | 18 ++++-----------
 2 files changed, 38 insertions(+), 26 deletions(-)

diff --git a/docs/plugins/fastdwarf.rst b/docs/plugins/fastdwarf.rst
index 65d2a3d45..d964b319a 100644
--- a/docs/plugins/fastdwarf.rst
+++ b/docs/plugins/fastdwarf.rst
@@ -1,14 +1,36 @@
 fastdwarf
 =========
-Controls speedydwarf and teledwarf. Speedydwarf makes dwarves move quickly
-and perform tasks quickly. Teledwarf makes dwarves move instantaneously,
-but do jobs at the same speed.
-
-:fastdwarf 0:   disables both (also ``0 0``)
-:fastdwarf 1:   enables speedydwarf and disables teledwarf (also ``1 0``)
-:fastdwarf 2:   sets a native debug flag in the game memory that implements an
-                even more aggressive version of speedydwarf.
-:fastdwarf 0 1: disables speedydwarf and enables teledwarf
-:fastdwarf 1 1: enables both
-
-See `superdwarf` for a per-creature version.
+Tags:
+:dfhack-keybind:`fastdwarf`
+
+Dwarves teleport and/or finish jobs instantly.
+
+Usage:
+
+``enable fastdwarf``
+    Enable the plugin.
+``fastdwarf <speed mode> [<tele mode>]``
+
+Examples
+--------
+
+``fastdwarf 1``
+    Make all your dwarves move and work at maximum speed.
+``fastdwarf 1 1``
+    In addition to working at maximum speed, dwarves also teleport to their
+    destinations.
+
+Options
+-------
+
+Speed modes:
+
+:0: Dwarves move and work at normal rates.
+:1: Dwarves move and work at maximum speed.
+:2: ALL units move (and work) at maximum speed, including creatures and
+    hostiles.
+
+Tele modes:
+
+:0: No teleportation.
+:1: Dwarves teleport to their destinations.
diff --git a/plugins/fastdwarf.cpp b/plugins/fastdwarf.cpp
index 3948d8577..787f85c5d 100644
--- a/plugins/fastdwarf.cpp
+++ b/plugins/fastdwarf.cpp
@@ -224,20 +224,10 @@ DFhackCExport command_result plugin_enable ( color_ostream &out, bool enable )
 
 DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
 {
-    commands.push_back(PluginCommand("fastdwarf",
-        "let dwarves teleport and/or finish jobs instantly",
-        fastdwarf, false,
-        "fastdwarf: make dwarves faster.\n"
-        "Usage:\n"
-        "  fastdwarf <speed> (tele)\n"
-        "Valid values for speed:\n"
-        " * 0 - Make dwarves move and work at standard speed.\n"
-        " * 1 - Make dwarves move and work at maximum speed.\n"
-        " * 2 - Make ALL creatures move and work at maximum speed.\n"
-        "Valid values for (tele):\n"
-        " * 0 - Disable dwarf teleportation (default)\n"
-        " * 1 - Make dwarves teleport to their destinations instantly.\n"
-        ));
+    commands.push_back(PluginCommand(
+        "fastdwarf",
+        "Dwarves teleport and/or finish jobs instantly.",
+        fastdwarf));
 
     return CR_OK;
 }