Settings descriptions update #54690

This commit is contained in:
Ramya Achutha Rao
2018-07-27 16:52:10 -07:00
parent 74ec3dc59c
commit f3ef439d3c
2 changed files with 23 additions and 27 deletions

View File

@@ -294,12 +294,12 @@ const editorConfiguration: IConfigurationNode = {
'editor.detectIndentation': {
'type': 'boolean',
'default': EDITOR_MODEL_DEFAULTS.detectIndentation,
'description': nls.localize('detectIndentation', "When opening a file, `#editor.tabSize#` and `#editor.insertSpaces#` will be detected based on the file contents.")
'description': nls.localize('detectIndentation', "Controls whether `#editor.tabSize#` and `#editor.insertSpaces#` will be automatically detected when a file is opened based on the file contents.")
},
'editor.roundedSelection': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.viewInfo.roundedSelection,
'description': nls.localize('roundedSelection', "Controls whether selections have rounded corners.")
'description': nls.localize('roundedSelection', "Controls whether selections should have rounded corners.")
},
'editor.scrollBeyondLastLine': {
'type': 'boolean',
@@ -346,17 +346,17 @@ const editorConfiguration: IConfigurationNode = {
'editor.hover.enabled': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.hover.enabled,
'description': nls.localize('hover.enabled', "Controls if the hover is shown")
'description': nls.localize('hover.enabled', "Controls whether the hover is shown.")
},
'editor.hover.delay': {
'type': 'number',
'default': EDITOR_DEFAULTS.contribInfo.hover.delay,
'description': nls.localize('hover.delay', "Controls the delay after which to show the hover")
'description': nls.localize('hover.delay', "Time delay in milliseconds after which to the hover is shown.")
},
'editor.hover.sticky': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.hover.sticky,
'description': nls.localize('hover.sticky', "Controls if the hover should remain visible when mouse is moved over it")
'description': nls.localize('hover.sticky', "Controls whether the hover should remain visible when mouse is moved over it.")
},
'editor.find.seedSearchStringFromSelection': {
'type': 'boolean',
@@ -366,7 +366,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.find.autoFindInSelection': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.find.autoFindInSelection,
'description': nls.localize('find.autoFindInSelection', "Controls whether the 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 whether the find operation is carried on selected text or the entire file in the editor.")
},
'editor.find.globalFindClipboard': {
'type': 'boolean',
@@ -430,7 +430,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.mouseWheelScrollSensitivity': {
'type': 'number',
'default': EDITOR_DEFAULTS.viewInfo.scrollbar.mouseWheelScrollSensitivity,
'description': nls.localize('mouseWheelScrollSensitivity', "A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events")
'description': nls.localize('mouseWheelScrollSensitivity', "A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events.")
},
'editor.multiCursorModifier': {
'type': 'string',
@@ -496,27 +496,27 @@ const editorConfiguration: IConfigurationNode = {
'editor.autoClosingBrackets': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.autoClosingBrackets,
'description': nls.localize('autoClosingBrackets', "Controls if the editor should automatically close brackets after opening them")
'description': nls.localize('autoClosingBrackets', "Controls whether the editor should automatically close brackets after the user adds an opening bracket.")
},
'editor.formatOnType': {
'type': 'boolean',
'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 whether the editor should automatically format the line after typing.")
},
'editor.formatOnPaste': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.formatOnPaste,
'description': nls.localize('formatOnPaste', "Controls if the editor should automatically format the pasted content. A formatter must be available and the formatter should be able to format a range in a document.")
'description': nls.localize('formatOnPaste', "Controls whether the editor should automatically format the pasted content. A formatter must be available and the formatter should be able to format a range in a document.")
},
'editor.autoIndent': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.autoIndent,
'description': nls.localize('autoIndent', "Controls if the editor should automatically adjust the indentation when users type, paste or move lines. Indentation rules of the language must be available.")
'description': nls.localize('autoIndent', "Controls whether the editor should automatically adjust the indentation when users type, paste or move lines. Extensions with indentation rules of the language must be available.")
},
'editor.suggestOnTriggerCharacters': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.suggestOnTriggerCharacters,
'description': nls.localize('suggestOnTriggerCharacters', "Controls if suggestions should automatically show up when typing trigger characters.")
'description': nls.localize('suggestOnTriggerCharacters', "Controls whether suggestions should automatically show up when typing trigger characters.")
},
'editor.acceptSuggestionOnEnter': {
'type': 'string',
@@ -634,12 +634,12 @@ const editorConfiguration: IConfigurationNode = {
'editor.fontLigatures': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.viewInfo.fontLigatures,
'description': nls.localize('fontLigatures', "Enables font ligatures.")
'description': nls.localize('fontLigatures', "Enables/Disables font ligatures.")
},
'editor.hideCursorInOverviewRuler': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.viewInfo.hideCursorInOverviewRuler,
'description': nls.localize('hideCursorInOverviewRuler', "Controls if the cursor should be hidden in the overview ruler.")
'description': nls.localize('hideCursorInOverviewRuler', "Controls whether the cursor should be hidden in the overview ruler.")
},
'editor.renderWhitespace': {
'type': 'string',
@@ -665,7 +665,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.highlightActiveIndentGuide': {
'type': 'boolean',
default: EDITOR_DEFAULTS.viewInfo.highlightActiveIndentGuide,
description: nls.localize('highlightActiveIndentGuide', "Controls whether the editor should highlight the active indent guide")
description: nls.localize('highlightActiveIndentGuide', "Controls whether the editor should highlight the active indent guide.")
},
'editor.renderLineHighlight': {
'type': 'string',
@@ -682,7 +682,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.codeLens': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.contribInfo.codeLens,
'description': nls.localize('codeLens', "Controls if the editor shows CodeLens")
'description': nls.localize('codeLens', "Controls whether the editor shows CodeLens")
},
'editor.folding': {
'type': 'boolean',
@@ -692,12 +692,8 @@ const editorConfiguration: IConfigurationNode = {
'editor.foldingStrategy': {
'type': 'string',
'enum': ['auto', 'indentation'],
'enumDescriptions': [
nls.localize('foldingStrategyAuto', 'If available, use a language specific folding strategy, otherwise falls back to the indentation based strategy.'),
nls.localize('foldingStrategyIndentation', 'Always use the indentation based folding strategy')
],
'default': EDITOR_DEFAULTS.contribInfo.foldingStrategy,
'description': nls.localize('foldingStrategy', "Controls the way folding ranges are computed. 'auto' picks uses a language specific folding strategy, if available. 'indentation' forces that the indentation based folding strategy is used.")
'description': nls.localize('foldingStrategy', "Controls the strategy for computing folding ranges. `auto` uses a language specific folding strategy, if available. `indentation` uses the indentation based folding strategy.")
},
'editor.showFoldingControls': {
'type': 'string',
@@ -733,7 +729,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.dragAndDrop': {
'type': 'boolean',
'default': EDITOR_DEFAULTS.dragAndDrop,
'description': nls.localize('dragAndDrop', "Controls if the editor should allow to move selections via drag and drop.")
'description': nls.localize('dragAndDrop', "Controls whether the editor should allow moving selections via drag and drop.")
},
'editor.accessibilitySupport': {
'type': 'string',
@@ -771,7 +767,7 @@ const editorConfiguration: IConfigurationNode = {
'properties': {
'source.organizeImports': {
'type': 'boolean',
'description': nls.localize('codeActionsOnSave.organizeImports', "Run organize imports on save?")
'description': nls.localize('codeActionsOnSave.organizeImports', "Controls whether organize imports action should be run on file save.")
}
},
'additionalProperties': {
@@ -783,7 +779,7 @@ const editorConfiguration: IConfigurationNode = {
'editor.codeActionsOnSaveTimeout': {
'type': 'number',
'default': EDITOR_DEFAULTS.contribInfo.codeActionsOnSaveTimeout,
'description': nls.localize('codeActionsOnSaveTimeout', "Timeout for code actions run on save.")
'description': nls.localize('codeActionsOnSaveTimeout', "Timeout in milliseconds after which the code actions that are run on save are cancelled.")
},
'editor.selectionClipboard': {
'type': 'boolean',
@@ -799,7 +795,7 @@ const editorConfiguration: IConfigurationNode = {
'diffEditor.ignoreTrimWhitespace': {
'type': 'boolean',
'default': true,
'description': nls.localize('ignoreTrimWhitespace', "Controls if the diff editor shows changes in leading or trailing whitespace as diffs")
'description': nls.localize('ignoreTrimWhitespace', "Controls whether the diff editor shows changes in leading or trailing whitespace as diffs.")
},
'editor.largeFileOptimizations': {
'type': 'boolean',
@@ -809,7 +805,7 @@ const editorConfiguration: IConfigurationNode = {
'diffEditor.renderIndicators': {
'type': 'boolean',
'default': true,
'description': nls.localize('renderIndicators', "Controls if the diff editor shows +/- indicators for added/removed changes")
'description': nls.localize('renderIndicators', "Controls whether the diff editor shows +/- indicators for added/removed changes.")
}
}
};

View File

@@ -331,7 +331,7 @@ configurationRegistry.registerConfiguration({
'editor.formatOnSaveTimeout': {
'type': 'number',
'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', "Timeout in milliseconds after which the formatting that is run on file save is cancelled."),
'overridable': true,
'scope': ConfigurationScope.RESOURCE
}