From 3969a366ecfa45f11923dcbb594923be87c25fc0 Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 18 Jul 2022 13:02:03 -0700 Subject: [PATCH] update docs for autoclothing --- docs/plugins/autoclothing.rst | 13 +++++++++++-- plugins/autoclothing.cpp | 15 +++------------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/plugins/autoclothing.rst b/docs/plugins/autoclothing.rst index 7169844dd..a3c53a65a 100644 --- a/docs/plugins/autoclothing.rst +++ b/docs/plugins/autoclothing.rst @@ -1,11 +1,20 @@ autoclothing ============ -Automatically manage clothing work orders, allowing the user to set how many of -each clothing type every citizen should have. Usage:: +Automatically manage clothing work orders. It allows you to set how many of each +clothing type every citizen should have. +Usage:: + + enable autoclothing autoclothing [number] +``material`` can be "cloth", "silk", "yarn", or "leather". The ``item`` can be +anything your civilization can produce, such as "dress" or "mitten". + +When invoked without a number, it shows the current configuration for that +material and item. + Examples: * ``autoclothing cloth "short skirt" 10``: diff --git a/plugins/autoclothing.cpp b/plugins/autoclothing.cpp index d19e647d5..83eb0398a 100644 --- a/plugins/autoclothing.cpp +++ b/plugins/autoclothing.cpp @@ -1,5 +1,3 @@ - -// some headers required for a plugin. Nothing special, just the basics. #include "Core.h" #include #include @@ -184,16 +182,9 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector [number]\n" - "Example:\n" - " autoclothing cloth \"short skirt\" 10\n" - " Sets the desired number of cloth short skirts available per citizen to 10.\n" - " autoclothing cloth dress\n" - " Displays the currently set number of cloth dresses chosen per citizen.\n" - )); + "autoclothing", + "Automatically manage clothing work orders", + autoclothing)); return CR_OK; }