Skip to content

Commit 56c9d0a

Browse files
authored
fix: improve settings descriptions for actions triggered on save (microsoft#230052)
* fix: improve settings descriptions for actions trigged on save * fix: improve phrasing in settings descriptions * fix: replace docs link with setting link * fix: extract option reference to parameter
1 parent 2016c3d commit 56c9d0a

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

src/vs/workbench/contrib/codeActions/browser/codeActionsContribution.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ const codeActionsOnSaveSchema: IConfigurationPropertySchema = {
6464
items: { type: 'string' }
6565
}
6666
],
67-
markdownDescription: nls.localize('editor.codeActionsOnSave', 'Run Code Actions for the editor on save. Code Actions must be specified and the editor must not be shutting down. Example: `"source.organizeImports": "explicit" `'),
67+
markdownDescription: nls.localize('editor.codeActionsOnSave', 'Run Code Actions for the editor on save. Code Actions must be specified and the editor must not be shutting down. When {0} is set to `afterDelay`, Code Actions will only be run when the file is saved explicitly. Example: `"source.organizeImports": "explicit" `', '`#files.autoSave#`'),
6868
type: ['object', 'array'],
6969
additionalProperties: {
7070
type: 'string',
@@ -94,7 +94,7 @@ const notebookCodeActionsOnSaveSchema: IConfigurationPropertySchema = {
9494
items: { type: 'string' }
9595
}
9696
],
97-
markdownDescription: nls.localize('notebook.codeActionsOnSave', 'Run a series of Code Actions for a notebook on save. Code Actions must be specified, the file must not be saved after delay, and the editor must not be shutting down. Example: `"notebook.source.organizeImports": "explicit"`'),
97+
markdownDescription: nls.localize('notebook.codeActionsOnSave', 'Run a series of Code Actions for a notebook on save. Code Actions must be specified and the editor must not be shutting down. When {0} is set to `afterDelay`, Code Actions will only be run when the file is saved explicitly. Example: `"notebook.source.organizeImports": "explicit"`', '`#files.autoSave#`'),
9898
type: 'object',
9999
additionalProperties: {
100100
type: ['string', 'boolean'],

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ configurationRegistry.registerConfiguration({
380380
properties: {
381381
'editor.formatOnSave': {
382382
'type': 'boolean',
383-
'description': nls.localize('formatOnSave', "Format a file on save. A formatter must be available, the file must not be saved after delay, and the editor must not be shutting down."),
383+
'markdownDescription': nls.localize('formatOnSave', "Format a file on save. A formatter must be available and the editor must not be shutting down. When {0} is set to `afterDelay`, the file will only be formatted when saved explicitly.", '`#files.autoSave#`'),
384384
'scope': ConfigurationScope.LANGUAGE_OVERRIDABLE,
385385
},
386386
'editor.formatOnSaveMode': {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1141,7 +1141,7 @@ configurationRegistry.registerConfiguration({
11411141
markdownEnumDescriptions: DefaultFormatter.extensionDescriptions
11421142
},
11431143
[NotebookSetting.formatOnSave]: {
1144-
markdownDescription: nls.localize('notebook.formatOnSave', "Format a notebook on save. A formatter must be available, the file must not be saved after delay, and the editor must not be shutting down."),
1144+
markdownDescription: nls.localize('notebook.formatOnSave', "Format a notebook on save. A formatter must be available and the editor must not be shutting down. When {0} is set to `afterDelay`, the file will only be formatted when saved explicitly.", '`#files.autoSave#`'),
11451145
type: 'boolean',
11461146
tags: ['notebookLayout'],
11471147
default: false

0 commit comments

Comments
 (0)