Skip to content

Commit d5379b5

Browse files
authored
Fix more settings description setting links (microsoft#154383)
Ref microsoft#154317
1 parent 368400c commit d5379b5

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

src/vs/editor/common/config/editorOptions.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2562,12 +2562,12 @@ class EditorInlayHints extends BaseEditorOption<EditorOption.inlayHints, IEditor
25622562
'editor.inlayHints.fontSize': {
25632563
type: 'number',
25642564
default: defaults.fontSize,
2565-
markdownDescription: nls.localize('inlayHints.fontSize', "Controls font size of inlay hints in the editor. As default the `#editor.fontSize#` is used when the configured value is less than `5` or greater than the editor font size.")
2565+
markdownDescription: nls.localize('inlayHints.fontSize', "Controls font size of inlay hints in the editor. As default the {0} is used when the configured value is less than {1} or greater than the editor font size.", '`#editor.fontSize#`', '`5`')
25662566
},
25672567
'editor.inlayHints.fontFamily': {
25682568
type: 'string',
25692569
default: defaults.fontFamily,
2570-
markdownDescription: nls.localize('inlayHints.fontFamily', "Controls font family of inlay hints in the editor. When set to empty, the `#editor.fontFamily#` is used.")
2570+
markdownDescription: nls.localize('inlayHints.fontFamily', "Controls font family of inlay hints in the editor. When set to empty, the {0} is used.", '`#editor.fontFamily#`')
25712571
},
25722572
'editor.inlayHints.padding': {
25732573
type: 'boolean',
@@ -3643,7 +3643,7 @@ class BracketPairColorization extends BaseEditorOption<EditorOption.bracketPairC
36433643
'editor.bracketPairColorization.enabled': {
36443644
type: 'boolean',
36453645
default: defaults.enabled,
3646-
markdownDescription: nls.localize('bracketPairColorization.enabled', "Controls whether bracket pair colorization is enabled or not. Use `#workbench.colorCustomizations#` to override the bracket highlight colors.")
3646+
markdownDescription: nls.localize('bracketPairColorization.enabled', "Controls whether bracket pair colorization is enabled or not. Use {0} to override the bracket highlight colors.", '`#workbench.colorCustomizations#`')
36473647
},
36483648
'editor.bracketPairColorization.independentColorPoolPerBracketType': {
36493649
type: 'boolean',
@@ -4897,7 +4897,7 @@ export const EditorOptions = {
48974897
'- `ctrlCmd` refers to a value the setting can take and should not be localized.',
48984898
'- `Control` and `Command` refer to the modifier keys Ctrl or Cmd on the keyboard and can be localized.'
48994899
]
4900-
}, "The modifier to be used to add multiple cursors with the mouse. The Go to Definition and Open Link mouse gestures will adapt such that they do not conflict with the multicursor modifier. [Read more](https://code.visualstudio.com/docs/editor/codebasics#_multicursor-modifier).")
4900+
}, "The modifier to be used to add multiple cursors with the mouse. The Go to Definition and Open Link mouse gestures will adapt such that they do not conflict with the [multicursor modifier](https://code.visualstudio.com/docs/editor/codebasics#_multicursor-modifier).")
49014901
}
49024902
)),
49034903
multiCursorPaste: register(new EditorStringEnumOption(
@@ -5088,12 +5088,12 @@ export const EditorOptions = {
50885088
suggestFontSize: register(new EditorIntOption(
50895089
EditorOption.suggestFontSize, 'suggestFontSize',
50905090
0, 0, 1000,
5091-
{ markdownDescription: nls.localize('suggestFontSize', "Font size for the suggest widget. When set to `0`, the value of `#editor.fontSize#` is used.") }
5091+
{ markdownDescription: nls.localize('suggestFontSize', "Font size for the suggest widget. When set to {0}, the value of {1} is used.", '`0`', '`#editor.fontSize#`') }
50925092
)),
50935093
suggestLineHeight: register(new EditorIntOption(
50945094
EditorOption.suggestLineHeight, 'suggestLineHeight',
50955095
0, 0, 1000,
5096-
{ markdownDescription: nls.localize('suggestLineHeight', "Line height for the suggest widget. When set to `0`, the value of `#editor.lineHeight#` is used. The minimum value is 8.") }
5096+
{ markdownDescription: nls.localize('suggestLineHeight', "Line height for the suggest widget. When set to {0}, the value of {1} is used. The minimum value is 8.", '`0`', '`#editor.lineHeight#`') }
50975097
)),
50985098
suggestOnTriggerCharacters: register(new EditorBooleanOption(
50995099
EditorOption.suggestOnTriggerCharacters, 'suggestOnTriggerCharacters', true,

src/vs/workbench/browser/workbench.contribution.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ const registry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Con
245245
},
246246
'workbench.editor.restoreViewState': {
247247
'type': 'boolean',
248-
'markdownDescription': localize('restoreViewState', "Restores the last editor view state (e.g. scroll position) when re-opening editors after they have been closed. Editor view state is stored per editor group and discarded when a group closes. Use the `#workbench.editor.sharedViewState#` setting to use the last known view state across all editor groups in case no previous view state was found for a editor group."),
248+
'markdownDescription': localize('restoreViewState', "Restores the last editor view state (e.g. scroll position) when re-opening editors after they have been closed. Editor view state is stored per editor group and discarded when a group closes. Use the {0} setting to use the last known view state across all editor groups in case no previous view state was found for a editor group.", '`#workbench.editor.sharedViewState#`'),
249249
'default': true,
250250
'scope': ConfigurationScope.LANGUAGE_OVERRIDABLE
251251
},
@@ -278,7 +278,7 @@ const registry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Con
278278
'type': 'number',
279279
'default': 10,
280280
'exclusiveMinimum': 0,
281-
'markdownDescription': localize('limitEditorsMaximum', "Controls the maximum number of opened editors. Use the `#workbench.editor.limit.perEditorGroup#` setting to control this limit per editor group or across all groups.")
281+
'markdownDescription': localize('limitEditorsMaximum', "Controls the maximum number of opened editors. Use the {0} setting to control this limit per editor group or across all groups.", '`#workbench.editor.limit.perEditorGroup#`')
282282
},
283283
'workbench.editor.limit.excludeDirty': {
284284
'type': 'boolean',
@@ -540,12 +540,12 @@ const registry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Con
540540
'window.titleSeparator': {
541541
'type': 'string',
542542
'default': isMacintosh ? ' \u2014 ' : ' - ',
543-
'markdownDescription': localize("window.titleSeparator", "Separator used by `window.title`.")
543+
'markdownDescription': localize("window.titleSeparator", "Separator used by {0}.", '`#window.title#`')
544544
},
545545
'window.commandCenter': {
546546
type: 'boolean',
547547
default: false,
548-
markdownDescription: localize('window.commandCenter', "Show command launcher together with the window title. This setting only has an effect when `#window.titleBarStyle#` is set to `custom`.")
548+
markdownDescription: localize('window.commandCenter', "Show command launcher together with the window title. This setting only has an effect when {0} is set to {1}.", '`#window.titleBarStyle#`', '`custom`')
549549
},
550550
'window.menuBarVisibility': {
551551
'type': 'string',
@@ -557,7 +557,7 @@ const registry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Con
557557
localize('window.menuBarVisibility.toggle.mac', "Menu is hidden but can be displayed at the top of the window by executing the `Focus Application Menu` command.") :
558558
localize('window.menuBarVisibility.toggle', "Menu is hidden but can be displayed at the top of the window via the Alt key."),
559559
localize('window.menuBarVisibility.hidden', "Menu is always hidden."),
560-
localize('window.menuBarVisibility.compact', "Menu is displayed as a compact button in the side bar. This value is ignored when `#window.titleBarStyle#` is `native`.")
560+
localize('window.menuBarVisibility.compact', "Menu is displayed as a compact button in the side bar. This value is ignored when {0} is {1}.", '`#window.titleBarStyle#`', '`native`')
561561
],
562562
'default': isWeb ? 'compact' : 'classic',
563563
'scope': ConfigurationScope.APPLICATION,

src/vs/workbench/contrib/files/browser/files.contribution.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ configurationRegistry.registerConfiguration({
185185
'files.autoGuessEncoding': {
186186
'type': 'boolean',
187187
'default': false,
188-
'markdownDescription': nls.localize('autoGuessEncoding', "When enabled, the editor will attempt to guess the character set encoding when opening files. This setting can also be configured per language. Note, this setting is not respected by text search. Only `#files.encoding#` is respected."),
188+
'markdownDescription': nls.localize('autoGuessEncoding', "When enabled, the editor will attempt to guess the character set encoding when opening files. This setting can also be configured per language. Note, this setting is not respected by text search. Only {0} is respected.", '`#files.encoding#`'),
189189
'scope': ConfigurationScope.LANGUAGE_OVERRIDABLE
190190
},
191191
'files.eol': {
@@ -475,7 +475,7 @@ configurationRegistry.registerConfiguration({
475475
},
476476
'explorer.excludeGitIgnore': {
477477
type: 'boolean',
478-
markdownDescription: nls.localize('excludeGitignore', "Controls whether entries in .gitignore should be parsed and excluded from the explorer. Similar to `#files.exclude#`."),
478+
markdownDescription: nls.localize('excludeGitignore', "Controls whether entries in .gitignore should be parsed and excluded from the explorer. Similar to {0}.", '`#files.exclude#`'),
479479
default: false,
480480
scope: ConfigurationScope.RESOURCE
481481
},
@@ -487,7 +487,7 @@ configurationRegistry.registerConfiguration({
487487
},
488488
'explorer.fileNesting.expand': {
489489
'type': 'boolean',
490-
'markdownDescription': nls.localize('fileNestingExpand', "Controls whether file nests are automatically expanded. `#explorer.fileNesting.enabled#` must be set for this to take effect."),
490+
'markdownDescription': nls.localize('fileNestingExpand', "Controls whether file nests are automatically expanded. {0} must be set for this to take effect.", '`#explorer.fileNesting.enabled#`'),
491491
'default': true,
492492
},
493493
'explorer.fileNesting.patterns': {

src/vs/workbench/contrib/notebook/browser/notebook.contribution.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -881,7 +881,7 @@ configurationRegistry.registerConfiguration({
881881
tags: ['notebookLayout']
882882
},
883883
[NotebookSetting.markupFontSize]: {
884-
markdownDescription: nls.localize('notebook.markup.fontSize', "Controls the font size in pixels of rendered markup in notebooks. When set to `0`, 120% of `#editor.fontSize#` is used."),
884+
markdownDescription: nls.localize('notebook.markup.fontSize', "Controls the font size in pixels of rendered markup in notebooks. When set to {0}, 120% of {1} is used.", '`0`', '`#editor.fontSize#`'),
885885
type: 'number',
886886
default: 0,
887887
tags: ['notebookLayout']
@@ -900,13 +900,13 @@ configurationRegistry.registerConfiguration({
900900
tags: ['notebookLayout']
901901
},
902902
[NotebookSetting.outputFontSize]: {
903-
markdownDescription: nls.localize('notebook.outputFontSize', "Font size for the output text for notebook cells. When set to 0 `#editor.fontSize#` is used."),
903+
markdownDescription: nls.localize('notebook.outputFontSize', "Font size for the output text for notebook cells. When set to {0}, {1} is used.", '`0`', '`#editor.fontSize#`'),
904904
type: 'number',
905905
default: 0,
906906
tags: ['notebookLayout']
907907
},
908908
[NotebookSetting.outputFontFamily]: {
909-
markdownDescription: nls.localize('notebook.outputFontFamily', "The font family for the output text for notebook cells. When set to empty, the `#editor.fontFamily#` is used."),
909+
markdownDescription: nls.localize('notebook.outputFontFamily', "The font family for the output text for notebook cells. When set to empty, the {0} is used.", '`#editor.fontFamily#`'),
910910
type: 'string',
911911
tags: ['notebookLayout']
912912
},

src/vs/workbench/contrib/remote/common/remote.contribution.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration)
353353
},
354354
'remote.autoForwardPortsSource': {
355355
type: 'string',
356-
markdownDescription: localize('remote.autoForwardPortsSource', "Sets the source from which ports are automatically forwarded when `remote.autoForwardPorts` is true. On Windows and Mac remotes, the `process` option has no effect and `output` will be used. Requires a reload to take effect."),
356+
markdownDescription: localize('remote.autoForwardPortsSource', "Sets the source from which ports are automatically forwarded when {0} is true. On Windows and Mac remotes, the `process` option has no effect and `output` will be used. Requires a reload to take effect.", '`#remote.autoForwardPorts#`'),
357357
enum: ['process', 'output'],
358358
enumDescriptions: [
359359
localize('remote.autoForwardPortsSource.process', "Ports will be automatically forwarded when discovered by watching for processes that are started and include a port."),
@@ -463,7 +463,7 @@ Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration)
463463
}
464464
},
465465
defaultSnippets: [{ body: { onAutoForward: 'ignore' } }],
466-
markdownDescription: localize('remote.portsAttributes.defaults', "Set default properties that are applied to all ports that don't get properties from the setting `remote.portsAttributes`. For example:\n\n```\n{\n \"onAutoForward\": \"ignore\"\n}\n```"),
466+
markdownDescription: localize('remote.portsAttributes.defaults', "Set default properties that are applied to all ports that don't get properties from the setting {0}. For example:\n\n```\n{\n \"onAutoForward\": \"ignore\"\n}\n```", '`#remote.portsAttributes#`'),
467467
additionalProperties: false
468468
},
469469
'remote.localPortHost': {

src/vs/workbench/contrib/search/browser/search.contribution.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@ configurationRegistry.registerConfiguration({
996996
'search.searchOnTypeDebouncePeriod': {
997997
type: 'number',
998998
default: 300,
999-
markdownDescription: nls.localize('search.searchOnTypeDebouncePeriod', "When `#search.searchOnType#` is enabled, controls the timeout in milliseconds between a character being typed and the search starting. Has no effect when `search.searchOnType` is disabled.")
999+
markdownDescription: nls.localize('search.searchOnTypeDebouncePeriod', "When {0} is enabled, controls the timeout in milliseconds between a character being typed and the search starting. Has no effect when {0} is disabled.", '`#search.searchOnType#`')
10001000
},
10011001
'search.searchEditor.doubleClickBehaviour': {
10021002
type: 'string',

0 commit comments

Comments
 (0)