From 870fa44019562823c2d68aa9edc018ffb25d9b86 Mon Sep 17 00:00:00 2001 From: Christian Bager Bach Houmann Date: Thu, 28 Sep 2023 10:27:28 +0200 Subject: [PATCH] docs: document description feature for settings with scripts --- docs/docs/Advanced/scriptsWithSettings.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/docs/Advanced/scriptsWithSettings.md b/docs/docs/Advanced/scriptsWithSettings.md index 441be38..965f1ef 100644 --- a/docs/docs/Advanced/scriptsWithSettings.md +++ b/docs/docs/Advanced/scriptsWithSettings.md @@ -26,6 +26,8 @@ For example, the following script will have a text field setting with the key `T ![Settings menu for the script](../Images/script_with_settings.png) +It's possible to give a description to a setting by adding a `description` property to the setting object. + ```js const TEXT_FIELD = "Text field"; @@ -42,6 +44,7 @@ module.exports = { type: "text", defaultValue: "", placeholder: "Placeholder", + description: "Description here.", }, "Checkbox": { type: "checkbox",