From ea3dfe399ed095858102158eaf8ce17365bead4b Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 25 Jul 2022 10:54:11 -0700 Subject: [PATCH] update docs for fixveins --- docs/plugins/fixveins.rst | 12 +++++++++--- plugins/fixveins.cpp | 5 +++-- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/plugins/fixveins.rst b/docs/plugins/fixveins.rst index 58678d154..940c13b7a 100644 --- a/docs/plugins/fixveins.rst +++ b/docs/plugins/fixveins.rst @@ -1,5 +1,11 @@ fixveins ======== -Removes invalid references to mineral inclusions and restores missing ones. -Use this if you broke your embark with tools like `tiletypes`, or if you -accidentally placed a construction on top of a valuable mineral floor. +Tags: +:dfhack-keybind:`fixveins` + +Restore missing mineral inclusions. This tool can also remove invalid references +to mineral inclusions if you broke your embark with tools like `tiletypes`. + +Usage:: + + fixveins diff --git a/plugins/fixveins.cpp b/plugins/fixveins.cpp index 84d475518..f633f8422 100644 --- a/plugins/fixveins.cpp +++ b/plugins/fixveins.cpp @@ -103,8 +103,9 @@ command_result df_fixveins (color_ostream &out, vector & parameters) DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { - commands.push_back(PluginCommand("fixveins", - "Remove invalid references to mineral inclusions and restore missing ones.", + commands.push_back(PluginCommand( + "fixveins", + "Restore missing mineral inclusions.", df_fixveins)); return CR_OK; }