docs: document description feature for settings with scripts

chhoumann · Sep 28, 2023 · 870fa44 · 870fa44 · vercel · Sep 28, 2023
1 parent 5fc2b5a
commit 870fa44
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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",