Document markdown-enabled manifest fields. (#11426)

Markdown support for rendering plugin settings in the system console is inconsistent. Let's start by at least documenting where it is supported.
Этот коммит содержится в:
Jesse Hallam
2019-06-28 16:57:25 -03:00
коммит произвёл Maria A Nunez
родитель 0cae57a6cd
Коммит ede426a806

Просмотреть файл

@@ -52,7 +52,7 @@ type PluginSetting struct {
// "username" will result in a text setting that will autocomplete to a username.
Type string `json:"type" yaml:"type"`
// The help text to display to the user.
// The help text to display to the user. Supports Markdown formatting.
HelpText string `json:"help_text" yaml:"help_text"`
// The help text to display alongside the "Regenerate" button for settings of the "generated" type.
@@ -70,10 +70,10 @@ type PluginSetting struct {
}
type PluginSettingsSchema struct {
// Optional text to display above the settings.
// Optional text to display above the settings. Supports Markdown formatting.
Header string `json:"header" yaml:"header"`
// Optional text to display below the settings.
// Optional text to display below the settings. Supports Markdown formatting.
Footer string `json:"footer" yaml:"footer"`
// A list of setting definitions.