You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This screenshot shows enhanced hover documentation for the 'type' property in a configuration document. The documentation includes a link at the top to the online documentation, followed by prose explaining the syntax for the property.
50
52
:::image-end:::
51
-
<!-- markdownlint-enable MD013-->
53
+
<!-- markdownlint-restore-->
52
54
53
55
With the enhanced schemas, hovering on a property displays contextual help rendered from Markdown.
54
56
When possible, the hover help includes a link to the online documentation.
@@ -59,9 +61,9 @@ When possible, the hover help includes a link to the online documentation.
59
61
:::image type="complex" source="media/enhanced-authoring/peek-help.png" alt-text="This screenshot shows enhanced documentation with autocomplete.":::
60
62
This screenshot shows the DSC Resource instance autocomplete option and contextual documentation in a configuration document. The contextual help is shown to the side of the completion option list. The help includes a link to the online documentation, the descriptive prose, and the required properties.
61
63
:::image-end:::
62
-
<!-- markdownlint-enable MD013-->
64
+
<!-- markdownlint-restore-->
63
65
64
-
When using IntelliSense while authoring with an enhanced schema, the quick info shown for the
66
+
When you use IntelliSense while authoring with an enhanced schema, the quick info shown for the
65
67
completion options displays as rendered Markdown. When possible, the quick info includes a link to
66
68
the online documentation.
67
69
@@ -71,7 +73,7 @@ the online documentation.
71
73
:::image type="complex" source="media/enhanced-authoring/enum-help.png" alt-text="This screenshot shows contextual documentation for an enum.":::
72
74
This screenshot shows the contextual documentation for the 'return' property enum values in a resource manifest. The contextual help is shown beneath the enum list, describing the currently selected value.
73
75
:::image-end:::
74
-
<!-- markdownlint-enable MD013-->
76
+
<!-- markdownlint-restore-->
75
77
76
78
The enhanced schemas add documentation for enum values when using IntelliSense to select a valid
77
79
value. By default, schemas can't provide per-enum documentation. They can only define documentation
@@ -87,7 +89,7 @@ for the property an enum belongs to.
87
89
:::image type="complex" source="media/enhanced-authoring/snippet-completion.png" alt-text="This screenshot shows the editable output for the chosen snippet.":::
88
90
This screenshot shows the editable output for the 'New metadata property (object)' snippet. It defined a new property named 'metadataName' with a nested key-value pair. The property name, key, and value are editable text that a user can tab through, like any other VS Code snippet.
89
91
:::image-end:::
90
-
<!-- markdownlint-enable MD013-->
92
+
<!-- markdownlint-restore-->
91
93
92
94
For common use cases, the enhanced schemas define sets of default snippets. These snippets are
93
95
contextual and make it easier and faster to define the file. The snippets work like any other
@@ -97,19 +99,19 @@ snippets in VS Code.
97
99
98
100
<!-- markdownlint-disable MD013 -->
99
101
:::image type="complex" source="media/enhanced-authoring/error-messages.png" alt-text="This screenshot shows an enhanced error message for failed validation.":::
100
-
This screenshot shows a contextual error message when the name property for a resource instance doesn't match the validating regular expression. The value is the string 'invalid?' and the error message says "Invalid value for instance name. An instance name must be a non-empty string containing only letters, numbers, and spaces."
102
+
This screenshot shows a contextual error message when the name property for a resource instance doesn't match the validating regular expression. The value is the string 'invalid?' and the error message says "Invalid value for instance name. An instance name must be a nonempty string containing only letters, numbers, and spaces."
101
103
:::image-end:::
102
-
<!-- markdownlint-enable MD013-->
104
+
<!-- markdownlint-restore-->
103
105
104
-
When defining values, the enhanced schemas have contextual error messages instead of the default
105
-
error messages that JSON schema validation raises. This is particularly helpful for properties that
106
-
must match a regular expression, where the default message just indicates that the value is invalid
107
-
and lists the regular expression pattern.
106
+
When you define values, the enhanced schemas provide contextual error messages instead of the
107
+
default error messages that JSON schema validation raises. These messages are helpful for
108
+
properties that must match a regular expression, where the default message just indicates that the
109
+
value is invalid and lists the regular expression pattern.
108
110
109
111
## Using the enhanced configuration document schema
110
112
111
113
To associate every configuration document with the enhanced schema, add the following snippet to
112
-
your [settings.json] file in VS Code. You can define these options in your user settings or for a
114
+
your `settings.json` file in VS Code. You can define these options in your user settings or for a
0 commit comments