Merge pull request #3546 from myk002/myk_misery

[misery] realign the docs to the actual implementation

docs/changelog.txt

@@ -44,6 +44,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
 - Suppress DF keyboard events when a DFHack keybinding is matched. This prevents, for example, a backtick from appearing in a textbox as text when you launch `gui/launcher` from the backtick keybinding.
 
 ## Documentation
+- `misery`: rewrite the documentation to clarify the actual effects of the plugin
 
 ## API
 - ``Units::getUnitByNobleRole``, ``Units::getUnitsByNobleRole``: unit lookup API by role

docs/plugins/misery.rst

@@ -2,11 +2,12 @@ misery
 ======
 
 .. dfhack-tool::
-    :summary: Increase the intensity of your citizens' negative thoughts.
+    :summary: Make citizens more miserable.
     :tags: fort gameplay units
 
-When enabled, negative thoughts that your citizens have will multiply by the
-specified factor. This makes it more challenging to keep them happy.
+When enabled, all of your citizens receive a negative thought about a
+particularly nasty soapy bath. You can vary the strength of this negative
+thought to increase or decrease the difficulty of keeping your citizens happy.
 
 Usage
 -----
@@ -18,18 +19,18 @@ Usage
     misery <factor>
     misery clear
 
-The default misery factor is ``2``, meaning that your dwarves will become
-miserable twice as fast.
+The default misery factor is ``2``, which will result in a moderate hit to your
+dwarves' happiness. Larger numbers increase the challenge.
 
 Examples
 --------
 
 ``enable misery``
-    Start multiplying bad thoughts for your citizens!
+    Start adding bad thoughts about nasty soapy baths to your citizens!
 
 ``misery 5``
-    Make dwarves become unhappy 5 times faster than normal -- this is quite
-    challenging to handle!
+    Change the strength of the soapy bath negative thought to something quite
+    large -- this is very challenging to handle!
 
 ``misery clear``
     Clear away negative thoughts added by ``misery``. Note that this will not

plugins/misery.cpp

@@ -72,7 +72,7 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector <Plugin
     // provide a configuration interface for the plugin
     commands.push_back(PluginCommand(
         plugin_name,
-        "Increase the intensity of negative dwarven thoughts.",
+        "Make citizens more miserable.",
         do_command));
 
     return CR_OK;