From a5a57a86312352e150f40dfaae66545971ee933e Mon Sep 17 00:00:00 2001 From: myk002 Date: Sun, 31 Jul 2022 13:31:40 -0700 Subject: [PATCH] update docs for tubefill --- docs/plugins/tubefill.rst | 15 +++++++++------ plugins/tubefill.cpp | 7 ++++--- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/plugins/tubefill.rst b/docs/plugins/tubefill.rst index 99c0b76bd..15a9ba2f2 100644 --- a/docs/plugins/tubefill.rst +++ b/docs/plugins/tubefill.rst @@ -1,11 +1,14 @@ tubefill ======== -Fills all the adamantine veins again. Veins that were hollow will be left -alone. +Tags: +:dfhack-keybind:`tubefill` -Options: +Replentishes mined-out adamantine. Veins that were hollow will be left alone. -:hollow: fill in naturally hollow veins too +Usage:: -Beware that filling in hollow veins will trigger a demon invasion on top of -your miner when you dig into the region that used to be hollow. + tubefill [hollow] + +Specify ``hollow`` to fill in naturally hollow veins too, but be aware that this +will trigger a demon invasion on top of your miner when you dig into the region +that used to be hollow. You have been warned! diff --git a/plugins/tubefill.cpp b/plugins/tubefill.cpp index 1803ed520..f86e77c76 100644 --- a/plugins/tubefill.cpp +++ b/plugins/tubefill.cpp @@ -40,9 +40,10 @@ command_result tubefill(color_ostream &out, std::vector & params); DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { - commands.push_back(PluginCommand("tubefill","Fill in all the adamantine tubes again.",tubefill, false, - "Replenishes mined out adamantine but does not fill hollow adamantine tubes.\n" - "Specify 'hollow' to fill hollow tubes, but beware glitchy HFS spawns.\n")); + commands.push_back(PluginCommand( + "tubefill", + "Replentishes mined-out adamantine.", + tubefill)); return CR_OK; }