From 6686f703aeeae31d43c6c548e5860a6bbbf7831c Mon Sep 17 00:00:00 2001
From: myk002 <myk002@yahoo.com>
Date: Sun, 31 Jul 2022 13:32:06 -0700
Subject: [PATCH] update docs for workNow

---
 docs/plugins/workNow.rst | 23 +++++++++++++++--------
 plugins/workNow.cpp      | 14 ++++----------
 2 files changed, 19 insertions(+), 18 deletions(-)

diff --git a/docs/plugins/workNow.rst b/docs/plugins/workNow.rst
index bacecf612..dda3fea5c 100644
--- a/docs/plugins/workNow.rst
+++ b/docs/plugins/workNow.rst
@@ -1,12 +1,19 @@
 workNow
 =======
-Don't allow dwarves to idle if any jobs are available.
+Tags:
+:dfhack-keybind:`workNow`
 
-When workNow is active, every time the game pauses, DF will make dwarves
-perform any appropriate available jobs.  This includes when you one step
-through the game using the pause menu.  Usage:
+Reduce the time that dwarves idle after completing a job. After finishing a job,
+dwarves will wander away for a while before picking up a new job. This plugin
+will automatically poke the game to assign dwarves to new tasks.
 
-:workNow:       print workNow status
-:workNow 0:     deactivate workNow
-:workNow 1:     activate workNow (look for jobs on pause, and only then)
-:workNow 2:     make dwarves look for jobs whenever a job completes
+Usage:
+
+``workNow``
+    Print current plugin status.
+``workNow 0``
+    Stop monitoring and poking.
+``workNow 1``
+    Poke the game to assign dwarves to tasks whenever the game is paused.
+``workNow 2``
+    Poke the game to assign dwarves to tasks whenever a dwarf finishes a job.
diff --git a/plugins/workNow.cpp b/plugins/workNow.cpp
index ae76b09f3..2286fee7e 100644
--- a/plugins/workNow.cpp
+++ b/plugins/workNow.cpp
@@ -29,16 +29,10 @@ DFhackCExport command_result plugin_init(color_ostream& out, std::vector<PluginC
     if (!process_jobs || !process_dig)
         return CR_FAILURE;
 
-    commands.push_back(PluginCommand("workNow", "Don't allow dwarves to idle if any jobs are available", workNow, false, "When workNow is active, every time the game pauses, DF will make dwarves perform any appropriate available jobs. This includes when you one step through the game using the pause menu. When workNow is in mode 2, it will make dwarves look for jobs every time a job completes.\n"
-                "workNow\n"
-                "  print workNow status\n"
-                "workNow 0\n"
-                "  deactivate workNow\n"
-                "workNow 1\n"
-                "  activate workNow (look for jobs on pause, and only then)\n"
-                "workNow 2\n"
-                "  make dwarves look for jobs whenever a job completes\n"
-    ));
+    commands.push_back(PluginCommand(
+        "workNow",
+        "Reduce the time that dwarves idle after completing a job.",
+        workNow));
 
     return CR_OK;
 }