From 1f3c4cdd18d9d7f67476d3104ded092161dd92aa Mon Sep 17 00:00:00 2001 From: myk002 Date: Wed, 20 Jul 2022 13:26:30 -0700 Subject: [PATCH] update docs for cleanconst --- docs/plugins/cleanconst.rst | 15 +++++++++++---- plugins/cleanconst.cpp | 9 +++------ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/plugins/cleanconst.rst b/docs/plugins/cleanconst.rst index a8169d83b..c34bac6bf 100644 --- a/docs/plugins/cleanconst.rst +++ b/docs/plugins/cleanconst.rst @@ -1,7 +1,14 @@ cleanconst ========== -Cleans up construction materials. -This utility alters all constructions on the map so that they spawn their -building component when they are disassembled, allowing their actual -build items to be safely deleted. This can improve FPS in extreme situations. +Tags: +:dfhack-keybind: + +Cleans up construction materials. This tool alters all constructions on the map +so that they spawn their building component when they are disassembled, allowing +their actual build items to be safely deleted. This can improve FPS when you +have many constructions on the map. + +Usage:: + + cleanconst diff --git a/plugins/cleanconst.cpp b/plugins/cleanconst.cpp index 84659c5d7..38149abd3 100644 --- a/plugins/cleanconst.cpp +++ b/plugins/cleanconst.cpp @@ -71,12 +71,9 @@ command_result df_cleanconst(color_ostream &out, vector & parameters) DFhackCExport command_result plugin_init ( color_ostream &out, vector &commands) { commands.push_back(PluginCommand( - "cleanconst", "Cleans up construction materials.", - df_cleanconst, false, - " This utility alters all constructions on the map so that they spawn their\n" - " building component when they are disassembled, allowing their actual\n" - " build items to be safely deleted.\n" - )); + "cleanconst", + "Cleans up construction materials.", + df_cleanconst)); return CR_OK; }