Skip to content

Commit

Permalink
fix: improve settings descriptions for actions trigged on save
Browse files Browse the repository at this point in the history
  • Loading branch information
elias-pap committed Sep 28, 2024
1 parent 2b0935a commit 22bef86
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ const codeActionsOnSaveSchema: IConfigurationPropertySchema = {
items: { type: 'string' }
}
],
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" `'),
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 [auto save](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save) is set to `afterDelay`, Code Actions will run when the file is saved explicitly, not when saved automatically. Example: `"source.organizeImports": "explicit" `'),
type: ['object', 'array'],
additionalProperties: {
type: 'string',
Expand Down Expand Up @@ -94,7 +94,7 @@ const notebookCodeActionsOnSaveSchema: IConfigurationPropertySchema = {
items: { type: 'string' }
}
],
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"`'),
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 [auto save](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save) is set to `afterDelay`, Code Actions will run when the file is saved explicitly, not when saved automatically. Example: `"notebook.source.organizeImports": "explicit"`'),
type: 'object',
additionalProperties: {
type: ['string', 'boolean'],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ configurationRegistry.registerConfiguration({
properties: {
'editor.formatOnSave': {
'type': 'boolean',
'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."),
'markdownDescription': nls.localize('formatOnSave', "Format a file on save. A formatter must be available and the editor must not be shutting down. When [auto save](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save) is set to `afterDelay`, the file will be formatted when saved explicitly, not when saved automatically."),
'scope': ConfigurationScope.LANGUAGE_OVERRIDABLE,
},
'editor.formatOnSaveMode': {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,7 @@ configurationRegistry.registerConfiguration({
markdownEnumDescriptions: DefaultFormatter.extensionDescriptions
},
[NotebookSetting.formatOnSave]: {
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."),
markdownDescription: nls.localize('notebook.formatOnSave', "Format a notebook on save. A formatter must be available and the editor must not be shutting down. When [auto save](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save) is set to `afterDelay`, the file will be formatted when saved explicitly, not when saved automatically."),
type: 'boolean',
tags: ['notebookLayout'],
default: false
Expand Down

0 comments on commit 22bef86

Please sign in to comment.