Skip to content

Commit 8c12d37

Browse files
committed
plugin: Document ConfigOption's Help field
1 parent 2738684 commit 8c12d37

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

pkg/plugin/plugin.go

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,13 @@ type ConfigOption struct {
3636
// An "en_US" locale must be given as a fallback
3737
Label map[string]string `json:"label"`
3838

39-
// Element title: When the user moves the mouse pointer over an element, a tooltip is displayed with a given message.
39+
// Element description map. Locale in the standard format (language_REGION) as key and corresponding label as value.
40+
// Locale is assumed to be UTF-8 encoded (Without the suffix in the locale)
41+
//
42+
// When the user moves the mouse pointer over an element in the web UI, a tooltip is displayed with a given message.
43+
//
44+
// e.g. {"en_US": "HTTP request method for the request.", "de_DE": "HTTP-Methode für die Anfrage."}
45+
// An "en_US" locale must be given as a fallback
4046
Help map[string]string `json:"help,omitempty"`
4147

4248
// Element default: bool for checkbox default value, string for other elements (used as placeholder)

0 commit comments

Comments
 (0)