Skip to content

Commit 6200396

Browse files
committed
Update documentation for lintWorkspaceGlobs configuration to clarify applicability.
1 parent 11e7775 commit 6200396

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,12 @@ For information about authoring custom rules, see [the `markdownlint` documentat
364364
365365
### markdownlint.lintWorkspaceGlobs
366366

367-
The globs used when linting a workspace with the `markdownlint.lintWorkspace` command match VS Code's concept of "Markdown files that matter":
367+
This property specifies the list of globs used when linting a workspace with the `markdownlint.lintWorkspace` command.
368+
369+
> **Note**: The `lintWorkspaceGlobs` setting is only used when running the `lintWorkspace` command.
370+
> To customize files that are linted by the standard editing experience, refer to the [Configure](#configure) section above.
371+
372+
The default list of globs matches VS Code's concept of "Markdown files that matter":
368373

369374
```jsonc
370375
[

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,20 @@
173173
"type": "object",
174174
"properties": {
175175
"markdownlint.config": {
176-
"description": "markdownlint configuration object",
176+
"description": "markdownlint configuration object.",
177177
"scope": "resource",
178178
"type": "object",
179179
"$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.40.0/schema/markdownlint-config-schema.json",
180180
"default": {}
181181
},
182182
"markdownlint.configFile": {
183-
"description": "Path to a configuration file that defines the base configuration",
183+
"description": "Path to a configuration file that defines the base configuration.",
184184
"scope": "resource",
185185
"type": "string",
186186
"default": null
187187
},
188188
"markdownlint.customRules": {
189-
"description": "Array of paths for custom rules to include when linting",
189+
"description": "Array of paths for custom rules to include when linting.",
190190
"scope": "resource",
191191
"type": "array",
192192
"items": {
@@ -195,7 +195,7 @@
195195
"default": []
196196
},
197197
"markdownlint.focusMode": {
198-
"description": "Makes it easier to focus while typing by hiding issues on or near the current line",
198+
"description": "Makes it easier to focus while typing by hiding issues on or near the current line.",
199199
"scope": "application",
200200
"type": [
201201
"boolean",
@@ -204,7 +204,7 @@
204204
"default": false
205205
},
206206
"markdownlint.lintWorkspaceGlobs": {
207-
"description": "Array of glob expressions to include or ignore when linting the workspace",
207+
"description": "Array of glob expressions to include or ignore when linting a workspace with the \"lintWorkspace\" command.",
208208
"scope": "resource",
209209
"type": "array",
210210
"items": {
@@ -220,7 +220,7 @@
220220
]
221221
},
222222
"markdownlint.run": {
223-
"description": "Run the linter on save (onSave) or on type (onType)",
223+
"description": "Run the linter on save (\"onSave\") or on type (\"onType\").",
224224
"scope": "resource",
225225
"type": "string",
226226
"enum": [
@@ -230,7 +230,7 @@
230230
"default": "onType"
231231
},
232232
"markdownlint.severityForError": {
233-
"description": "VS Code diagnostic level to use for issues with severity \"error\"",
233+
"description": "VS Code diagnostic level to use for issues with severity \"error\".",
234234
"scope": "resource",
235235
"type": "string",
236236
"enum": [
@@ -243,7 +243,7 @@
243243
"default": "Warning"
244244
},
245245
"markdownlint.severityForWarning": {
246-
"description": "VS Code diagnostic level to use for issues with severity \"warning\"",
246+
"description": "VS Code diagnostic level to use for issues with severity \"warning\".",
247247
"scope": "resource",
248248
"type": "string",
249249
"enum": [

0 commit comments

Comments
 (0)