Skip to content

Commit

Permalink
Document markdownDeprecationMessage microsoft/vscode#91618
Browse files Browse the repository at this point in the history
  • Loading branch information
roblourens committed Apr 29, 2020
1 parent 3af91c3 commit 7078c57
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions api/references/contribution-points.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,25 @@ You can also provide an `enumDescriptions` property, which provides descriptive
}
```

You can also use `markdownEnumDescriptions`, and your descriptions will be rendered as markdown.

**deprecationMessage** / **markdownDeprecationMessage**

If you set `deprecationMessage`, or `markdownDeprecationMessage`, the setting will get a warning underline with your specified message. It won't show up in the settings UI unless it is configured by the user. If you set `markdownDeprecationMessage`, the markdown will not be rendered in the setting hover or the problems view. If you set both properties, `deprecationMessage` will be shown in the hover and the problems view, and `markdownDeprecationMessage` will be rendered as markdown in the settings UI.

Example:

```json
{
"json.colorDecorators.enable": {
"type": "boolean",
"description": "Enables or disables color decorators",
"markdownDeprecationMessage": "**Deprecated**: Please use `#editor.colorDecorators#` instead.",
"deprecationMessage": "Deprecated: Please use editor.colorDecorators instead."
}
}
```

**Other JSON Schema properties**

You can use any the properties defined by JSON Schema to describe other constraints on configuration values.
Expand Down

0 comments on commit 7078c57

Please sign in to comment.