Skip to content

Commit b7c556a

Browse files
committed
docs: tweak some setting descriptions
1 parent c6c2043 commit b7c556a

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ the entire line wherever a diagnostic is generated by the language and also prin
3030
|errorLens.selectProblem|Error Lens: Set editor selection to the problem range (controlled by `errorLens.selectProblemType` setting).|
3131
|errorlens.toggleWorkspace|Error Lens: Exclude/Include current workspace by fs path.|
3232
|errorLens.disableLine|Error Lens: Add a comment to disable line for linter rule. Comment format is controlled by `"errorLens.disableLineComments"` setting.|
33-
|errorLens.findLinterRuleDefinition|Error Lens: Search in local linter files (like `.eslintrc.json`) for the rule definition.|
33+
|errorLens.findLinterRuleDefinition|Error Lens: Search in local linter files (like `.eslintrc.json`) for the rule definition. Target files are controlled by "errorLens.lintFilePaths" setting.|
3434
|errorLens.copyProblemMessage|Error Lens: Copy problem message to the clipboard (at the active cursor).|
3535
|errorLens.copyProblemCode|Error Lens: Copy problem code to the clipboard (at the active cursor).|
3636
<!-- COMMANDS_END -->
@@ -49,7 +49,7 @@ the entire line wherever a diagnostic is generated by the language and also prin
4949
|fontStyleItalic|**false**|When enabled - shows inline message in italic font style.|
5050
|fontSize|""|Font size of inline message ([CSS units](https://developer.mozilla.org/en-US/docs/Web/CSS/length)).|
5151
|margin|"4ch"|Distance between the last word on the line and the start of inline message ([CSS units](https://developer.mozilla.org/en-US/docs/Web/CSS/length)).|
52-
|alignMessage|\{"start":0, "end":0, "minimumMargin":0\}|Align inline error message (either by starting position or ending position).|
52+
|alignMessage|\{"start":0, "end":0, "minimumMargin":0\}|Align inline error message (either by starting position or ending position). Set "start" and "end" to **0** to disable.|
5353
|padding|""|Padding of the inline message. Visible when `#errorLens.messageBackgroundMode#` is set to "message".|
5454
|borderRadius|"0.2em"|Border radius of the inline message. Visible when `#errorLens.messageBackgroundMode#` is set to "message".|
5555
|enabledDiagnosticLevels|\["error", "warning", "info"\]|Customize which diagnostic levels(severity) to highlight.|
@@ -86,7 +86,7 @@ the entire line wherever a diagnostic is generated by the language and also prin
8686
|delay|**0**|Delay (ms) before showing problem decorations (**0** to disable). Minimum delay of **500** is enforced by the extension. `#errorLens.delayMode#` controls how to handle the delay.|
8787
|delayMode|"new"|Pick which version of the delay to use.|
8888
|onSave|**false**|When enabled - updates decorations only on document save (manual).|
89-
|onSaveTimeout|**1000**|Time period (ms) that used for showing decorations after the document save.|
89+
|onSaveTimeout|**1000**|Time period (ms) that used for showing decorations after the document save (manual, not auto save).|
9090
|onSaveUpdateOnActiveEditorChange|**true**|When `#errorLens.onSave#` enabled - extension still draws decorations when active/visible editors change.|
9191
|enableOnDiffView|**false**|Enable decorations when viewing a diff view in the editor (e.g. Git diff).|
9292
|followCursor|"allLines"|Highlight only portion of the problems.|

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
{
105105
"command": "errorLens.findLinterRuleDefinition",
106106
"title": "Find Linter Rule Definition",
107-
"description": "Search in local linter files (like `.eslintrc.json`) for the rule definition.",
107+
"description": "Search in local linter files (like `.eslintrc.json`) for the rule definition. Target files are controlled by \"errorLens.lintFilePaths\" setting.",
108108
"category": "Error Lens"
109109
},
110110
{
@@ -228,7 +228,7 @@
228228
"end": 0,
229229
"minimumMargin": 0
230230
},
231-
"markdownDescription": "Align inline error message (either by starting position or ending position).",
231+
"markdownDescription": "Align inline error message (either by starting position or ending position). Set \"start\" and \"end\" to **0** to disable.",
232232
"additionalProperties": false
233233
},
234234
"errorLens.padding": {

0 commit comments

Comments
 (0)