提交 1fad9cb8 编写于 作者: R Rob Lourens

Settings editor - clean some setting descriptions, #54690

上级 569c21de
...@@ -361,17 +361,17 @@ const editorConfiguration: IConfigurationNode = { ...@@ -361,17 +361,17 @@ const editorConfiguration: IConfigurationNode = {
'editor.find.seedSearchStringFromSelection': { 'editor.find.seedSearchStringFromSelection': {
'type': 'boolean', 'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.find.seedSearchStringFromSelection, 'default': EDITOR_DEFAULTS.contribInfo.find.seedSearchStringFromSelection,
'description': nls.localize('find.seedSearchStringFromSelection', "Controls if we seed the search string in Find Widget from editor selection") 'description': nls.localize('find.seedSearchStringFromSelection', "Controls if we seed the search string in Find Widget from editor selection.")
}, },
'editor.find.autoFindInSelection': { 'editor.find.autoFindInSelection': {
'type': 'boolean', 'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.find.autoFindInSelection, 'default': EDITOR_DEFAULTS.contribInfo.find.autoFindInSelection,
'description': nls.localize('find.autoFindInSelection', "Controls if Find in Selection flag is turned on when multiple characters or lines of text are selected in the editor") 'description': nls.localize('find.autoFindInSelection', "Controls if the Find in Selection flag is turned on when multiple characters or lines of text are selected in the editor.")
}, },
'editor.find.globalFindClipboard': { 'editor.find.globalFindClipboard': {
'type': 'boolean', 'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.find.globalFindClipboard, 'default': EDITOR_DEFAULTS.contribInfo.find.globalFindClipboard,
'description': nls.localize('find.globalFindClipboard', "Controls if the Find Widget should read or modify the shared find clipboard on macOS"), 'description': nls.localize('find.globalFindClipboard', "Controls if the Find Widget should read or modify the shared find clipboard on macOS."),
'included': platform.isMacintosh 'included': platform.isMacintosh
}, },
'editor.wordWrap': { 'editor.wordWrap': {
...@@ -401,7 +401,7 @@ const editorConfiguration: IConfigurationNode = { ...@@ -401,7 +401,7 @@ const editorConfiguration: IConfigurationNode = {
'- \'off\', \'on\', \'wordWrapColumn\' and \'bounded\' refer to values the setting can take and should not be localized.', '- \'off\', \'on\', \'wordWrapColumn\' and \'bounded\' refer to values the setting can take and should not be localized.',
'- `editor.wordWrapColumn` refers to a different setting and should not be localized.' '- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
] ]
}, "Controls how lines should wrap. Can be:\n - 'off' (disable wrapping),\n - 'on' (viewport wrapping),\n - 'wordWrapColumn' (wrap at `editor.wordWrapColumn`) or\n - 'bounded' (wrap at minimum of viewport and `editor.wordWrapColumn`).") }, "Controls how lines should wrap.")
}, },
'editor.wordWrapColumn': { 'editor.wordWrapColumn': {
'type': 'integer', 'type': 'integer',
...@@ -413,7 +413,7 @@ const editorConfiguration: IConfigurationNode = { ...@@ -413,7 +413,7 @@ const editorConfiguration: IConfigurationNode = {
'- `editor.wordWrap` refers to a different setting and should not be localized.', '- `editor.wordWrap` refers to a different setting and should not be localized.',
'- \'wordWrapColumn\' and \'bounded\' refer to values the different setting can take and should not be localized.' '- \'wordWrapColumn\' and \'bounded\' refer to values the different setting can take and should not be localized.'
] ]
}, "Controls the wrapping column of the editor when `editor.wordWrap` is 'wordWrapColumn' or 'bounded'.") }, "Controls the wrapping column of the editor when [`editor.wordWrap`](#editor.wordWrap) is `wordWrapColumn` or `bounded`.")
}, },
'editor.wrappingIndent': { 'editor.wrappingIndent': {
'type': 'string', 'type': 'string',
...@@ -440,7 +440,7 @@ const editorConfiguration: IConfigurationNode = { ...@@ -440,7 +440,7 @@ const editorConfiguration: IConfigurationNode = {
'- `ctrlCmd` refers to a value the setting can take and should not be localized.', '- `ctrlCmd` refers to a value the setting can take and should not be localized.',
'- `Control` and `Command` refer to the modifier keys Ctrl or Cmd on the keyboard and can be localized.' '- `Control` and `Command` refer to the modifier keys Ctrl or Cmd on the keyboard and can be localized.'
] ]
}, "The modifier to be used to add multiple cursors with the mouse. `ctrlCmd` maps to `Control` on Windows and Linux and to `Command` on macOS. 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)") }, "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).")
}, },
'editor.multiCursorMergeOverlapping': { 'editor.multiCursorMergeOverlapping': {
'type': 'boolean', 'type': 'boolean',
...@@ -495,7 +495,7 @@ const editorConfiguration: IConfigurationNode = { ...@@ -495,7 +495,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.formatOnType': { 'editor.formatOnType': {
'type': 'boolean', 'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.formatOnType, 'default': EDITOR_DEFAULTS.contribInfo.formatOnType,
'description': nls.localize('formatOnType', "Controls if the editor should automatically format the line after typing") 'description': nls.localize('formatOnType', "Controls if the editor should automatically format the line after typing.")
}, },
'editor.formatOnPaste': { 'editor.formatOnPaste': {
'type': 'boolean', 'type': 'boolean',
...@@ -613,17 +613,17 @@ const editorConfiguration: IConfigurationNode = { ...@@ -613,17 +613,17 @@ const editorConfiguration: IConfigurationNode = {
'type': 'string', 'type': 'string',
'enum': ['block', 'block-outline', 'line', 'line-thin', 'underline', 'underline-thin'], 'enum': ['block', 'block-outline', 'line', 'line-thin', 'underline', 'underline-thin'],
'default': editorOptions.cursorStyleToString(EDITOR_DEFAULTS.viewInfo.cursorStyle), 'default': editorOptions.cursorStyleToString(EDITOR_DEFAULTS.viewInfo.cursorStyle),
'description': nls.localize('cursorStyle', "Controls the cursor style, accepted values are 'block', 'block-outline', 'line', 'line-thin', 'underline' and 'underline-thin'") 'description': nls.localize('cursorStyle', "Controls the cursor style.")
}, },
'editor.cursorWidth': { 'editor.cursorWidth': {
'type': 'integer', 'type': 'integer',
'default': EDITOR_DEFAULTS.viewInfo.cursorWidth, 'default': EDITOR_DEFAULTS.viewInfo.cursorWidth,
'description': nls.localize('cursorWidth', "Controls the width of the cursor when editor.cursorStyle is set to 'line'") 'description': nls.localize('cursorWidth', "Controls the width of the cursor when [`editor.cursorStyle`](#editor.cursorStyle) is set to `line`.")
}, },
'editor.fontLigatures': { 'editor.fontLigatures': {
'type': 'boolean', 'type': 'boolean',
'default': EDITOR_DEFAULTS.viewInfo.fontLigatures, 'default': EDITOR_DEFAULTS.viewInfo.fontLigatures,
'description': nls.localize('fontLigatures', "Enables font ligatures") 'description': nls.localize('fontLigatures', "Enables font ligatures.")
}, },
'editor.hideCursorInOverviewRuler': { 'editor.hideCursorInOverviewRuler': {
'type': 'boolean', 'type': 'boolean',
...@@ -633,8 +633,13 @@ const editorConfiguration: IConfigurationNode = { ...@@ -633,8 +633,13 @@ const editorConfiguration: IConfigurationNode = {
'editor.renderWhitespace': { 'editor.renderWhitespace': {
'type': 'string', 'type': 'string',
'enum': ['none', 'boundary', 'all'], 'enum': ['none', 'boundary', 'all'],
'enumDescriptions': [
'',
nls.localize('renderWhiteSpace.boundary', "Render whitespace characters except for single spaces between words."),
''
],
default: EDITOR_DEFAULTS.viewInfo.renderWhitespace, default: EDITOR_DEFAULTS.viewInfo.renderWhitespace,
description: nls.localize('renderWhitespace', "Controls how the editor should render whitespace characters, possibilities are 'none', 'boundary', and 'all'. The 'boundary' option does not render single spaces between words.") description: nls.localize('renderWhitespace', "Controls how the editor should render whitespace characters.")
}, },
'editor.renderControlCharacters': { 'editor.renderControlCharacters': {
'type': 'boolean', 'type': 'boolean',
......
...@@ -192,7 +192,7 @@ configurationRegistry.registerConfiguration({ ...@@ -192,7 +192,7 @@ configurationRegistry.registerConfiguration({
}, },
'files.associations': { 'files.associations': {
'type': 'object', 'type': 'object',
'description': nls.localize('associations', "Configure file associations to languages (e.g. \"*.extension\": \"html\"). These have precedence over the default associations of the languages installed."), 'description': nls.localize('associations', "Configure file associations to languages (e.g. `\"*.extension\": \"html\"`). These have precedence over the default associations of the languages installed."),
}, },
'files.encoding': { 'files.encoding': {
'type': 'string', 'type': 'string',
...@@ -246,17 +246,17 @@ configurationRegistry.registerConfiguration({ ...@@ -246,17 +246,17 @@ configurationRegistry.registerConfiguration({
'enum': [AutoSaveConfiguration.OFF, AutoSaveConfiguration.AFTER_DELAY, AutoSaveConfiguration.ON_FOCUS_CHANGE, AutoSaveConfiguration.ON_WINDOW_CHANGE], 'enum': [AutoSaveConfiguration.OFF, AutoSaveConfiguration.AFTER_DELAY, AutoSaveConfiguration.ON_FOCUS_CHANGE, AutoSaveConfiguration.ON_WINDOW_CHANGE],
'enumDescriptions': [ 'enumDescriptions': [
nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.off' }, "A dirty file is never automatically saved."), nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.off' }, "A dirty file is never automatically saved."),
nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.afterDelay' }, "A dirty file is automatically saved after the configured 'files.autoSaveDelay'."), nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.afterDelay' }, "A dirty file is automatically saved after the configured [`files.autoSaveDelay`](#files.autoSaveDelay)."),
nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.onFocusChange' }, "A dirty file is automatically saved when the editor loses focus."), nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.onFocusChange' }, "A dirty file is automatically saved when the editor loses focus."),
nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.onWindowChange' }, "A dirty file is automatically saved when the window loses focus.") nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'files.autoSave.onWindowChange' }, "A dirty file is automatically saved when the window loses focus.")
], ],
'default': AutoSaveConfiguration.OFF, 'default': AutoSaveConfiguration.OFF,
'description': nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'autoSave' }, "Controls auto save of dirty files. Accepted values: '{0}', '{1}', '{2}' (editor loses focus), '{3}' (window loses focus). If set to '{4}', you can configure the delay in [`files.autoSaveDelay`](#files.autoSaveDelay). Read more about autosave [here](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save)", AutoSaveConfiguration.OFF, AutoSaveConfiguration.AFTER_DELAY, AutoSaveConfiguration.ON_FOCUS_CHANGE, AutoSaveConfiguration.ON_WINDOW_CHANGE, AutoSaveConfiguration.AFTER_DELAY) 'description': nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'autoSave' }, "Controls auto save of dirty files. Read more about autosave [here](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save).", AutoSaveConfiguration.OFF, AutoSaveConfiguration.AFTER_DELAY, AutoSaveConfiguration.ON_FOCUS_CHANGE, AutoSaveConfiguration.ON_WINDOW_CHANGE, AutoSaveConfiguration.AFTER_DELAY)
}, },
'files.autoSaveDelay': { 'files.autoSaveDelay': {
'type': 'number', 'type': 'number',
'default': 1000, 'default': 1000,
'description': nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'autoSaveDelay' }, "Controls the delay in ms after which a dirty file is saved automatically. Only applies when [`files.autoSave`](#files.autoSave) is set to '{0}'", AutoSaveConfiguration.AFTER_DELAY) 'description': nls.localize({ comment: ['This is the description for a setting. Values surrounded by single quotes are not to be translated.'], key: 'autoSaveDelay' }, "Controls the delay in ms after which a dirty file is saved automatically. Only applies when [`files.autoSave`](#files.autoSave) is set to `{0}`.", AutoSaveConfiguration.AFTER_DELAY)
}, },
'files.watcherExclude': { 'files.watcherExclude': {
'type': 'object', 'type': 'object',
...@@ -308,7 +308,7 @@ configurationRegistry.registerConfiguration({ ...@@ -308,7 +308,7 @@ configurationRegistry.registerConfiguration({
'editor.formatOnSaveTimeout': { 'editor.formatOnSaveTimeout': {
'type': 'number', 'type': 'number',
'default': 750, 'default': 750,
'description': nls.localize('formatOnSaveTimeout', "Format on save timeout. Specifies a time limit in milliseconds for formatOnSave-commands. Commands taking longer than the specified timeout will be cancelled."), 'description': nls.localize('formatOnSaveTimeout', "Format on save timeout. Specifies a time limit in milliseconds for `formatOnSave`-commands. Commands taking longer than the specified timeout will be cancelled."),
'overridable': true, 'overridable': true,
'scope': ConfigurationScope.RESOURCE 'scope': ConfigurationScope.RESOURCE
} }
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册