Skip to content

Commit

Permalink
fix: Change the description of diagnosticLevel (#3808)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S authored Nov 19, 2024
1 parent 944d21f commit 77e3c10
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 12 deletions.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@
"Report Spelling Issues as Information",
"Report Spelling Issues as Hints, will not show up in Problems"
],
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#`\nto control how issues are displayed in the document.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane.\n\nNote: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"scope": "resource",
"title": "Set Diagnostic Reporting Level",
"type": "string"
Expand Down Expand Up @@ -3213,7 +3213,7 @@
},
"cSpell.useCustomDecorations": {
"default": true,
"markdownDescription": "Draw custom decorations on Spelling Issues.\n- `true` - Use custom decorations.\n- `false` - Use the VS Code Diagnostic Collection to render spelling issues.",
"markdownDescription": "Draw custom decorations on Spelling Issues.\n- `true` - Use custom decorations. - VS Code Diagnostic Severity Levels are not used.\n- `false` - Use the VS Code Diagnostic Collection to render spelling issues.\n\nNote: This setting overrides the VS Code Diagnostics setting: `#cSpell.diagnosticLevel#`.",
"scope": "application",
"since": "4.0.0",
"type": "boolean"
Expand Down Expand Up @@ -3768,7 +3768,7 @@
"Report Spelling Issues as Information",
"Report Spelling Issues as Hints, will not show up in Problems"
],
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#`\nto control how issues are displayed in the document.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane.\n\nNote: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"scope": "resource",
"title": "Set Diagnostic Reporting Level",
"type": "string"
Expand Down
12 changes: 6 additions & 6 deletions packages/_server/spell-checker-config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
},
"diagnosticLevel": {
"default": "Information",
"description": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document. Set the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#` to control how issues are displayed in the document.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"description": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document. Set the level to `Hint` to hide the issues from the Problems Pane.\n\nNote: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"enum": [
"Error",
"Warning",
Expand All @@ -146,7 +146,7 @@
"Report Spelling Issues as Information",
"Report Spelling Issues as Hints, will not show up in Problems"
],
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#`\nto control how issues are displayed in the document.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane.\n\nNote: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"scope": "resource",
"title": "Set Diagnostic Reporting Level",
"type": "string"
Expand Down Expand Up @@ -2826,8 +2826,8 @@
},
"cSpell.useCustomDecorations": {
"default": true,
"description": "Draw custom decorations on Spelling Issues.\n- `true` - Use custom decorations.\n- `false` - Use the VS Code Diagnostic Collection to render spelling issues.",
"markdownDescription": "Draw custom decorations on Spelling Issues.\n- `true` - Use custom decorations.\n- `false` - Use the VS Code Diagnostic Collection to render spelling issues.",
"description": "Draw custom decorations on Spelling Issues.\n- `true` - Use custom decorations. - VS Code Diagnostic Severity Levels are not used.\n- `false` - Use the VS Code Diagnostic Collection to render spelling issues.\n\nNote: This setting overrides the VS Code Diagnostics setting: `#cSpell.diagnosticLevel#`.",
"markdownDescription": "Draw custom decorations on Spelling Issues.\n- `true` - Use custom decorations. - VS Code Diagnostic Severity Levels are not used.\n- `false` - Use the VS Code Diagnostic Collection to render spelling issues.\n\nNote: This setting overrides the VS Code Diagnostics setting: `#cSpell.diagnosticLevel#`.",
"scope": "application",
"since": "4.0.0",
"type": "boolean"
Expand Down Expand Up @@ -3436,7 +3436,7 @@
},
"cSpell.diagnosticLevel": {
"default": "Information",
"description": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document. Set the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#` to control how issues are displayed in the document.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"description": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document. Set the level to `Hint` to hide the issues from the Problems Pane.\n\nNote: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"enum": [
"Error",
"Warning",
Expand All @@ -3449,7 +3449,7 @@
"Report Spelling Issues as Information",
"Report Spelling Issues as Hints, will not show up in Problems"
],
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#`\nto control how issues are displayed in the document.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"markdownDescription": "The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.\nSet the level to `Hint` to hide the issues from the Problems Pane.\n\nNote: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.\n\nSee: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)",
"scope": "resource",
"title": "Set Diagnostic Reporting Level",
"type": "string"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,11 @@ interface Appearance extends Decoration {
export interface AppearanceSettings extends Appearance {
/**
* Draw custom decorations on Spelling Issues.
* - `true` - Use custom decorations.
* - `true` - Use custom decorations. - VS Code Diagnostic Severity Levels are not used.
* - `false` - Use the VS Code Diagnostic Collection to render spelling issues.
*
* Note: This setting overrides the VS Code Diagnostics setting: `#cSpell.diagnosticLevel#`.
*
* @scope application
* @since 4.0.0
* @default true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@ export interface SpellCheckerSettings

/**
* The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document.
* Set the level to `Hint` to hide the issues from the Problems Pane. Use the `#cSpell.useCustomDecorations#`
* to control how issues are displayed in the document.
* Set the level to `Hint` to hide the issues from the Problems Pane.
*
* Note: `#cSpell.useCustomDecorations#` must be `false` to use VS Code Diagnostic Severity Levels.
*
* See: [VS Code Diagnostic Severity Level](https://code.visualstudio.com/api/references/vscode-api#DiagnosticSeverity)
* @title Set Diagnostic Reporting Level
Expand Down

0 comments on commit 77e3c10

Please sign in to comment.