Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: improve settings descriptions for actions triggered on save #230052

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+4 −4
Open

fix: improve settings descriptions for actions triggered on save #230052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d32588c
fix: improve settings descriptions for actions trigged on save
elias-pap Sep 28, 2024
2de9ac0
fix: improve phrasing in settings descriptions
elias-pap Oct 11, 2024
242ad96
fix: replace docs link with setting link
elias-pap Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/vs/workbench/contrib/codeActions/browser/codeActionsContribution.ts
View file
Open in desktop
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 `#files.autoSave#` is set to `afterDelay`, Code Actions will only be run when the file is saved explicitly. 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 `#files.autoSave#` is set to `afterDelay`, Code Actions will only be run when the file is saved explicitly. Example: `"notebook.source.organizeImports": "explicit"`'),
type: 'object',
additionalProperties: {
type: ['string', 'boolean'],
Expand Down
2 changes: 1 addition & 1 deletion src/vs/workbench/contrib/files/browser/files.contribution.ts
View file
Open in desktop
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 `#files.autoSave#` is set to `afterDelay`, the file will only be formatted when saved explicitly."),
'scope': ConfigurationScope.LANGUAGE_OVERRIDABLE,
},
'editor.formatOnSaveMode': {
Expand Down
2 changes: 1 addition & 1 deletion src/vs/workbench/contrib/notebook/browser/notebook.contribution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1141,7 +1141,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 `#files.autoSave#` is set to `afterDelay`, the file will only be formatted when saved explicitly."),
type: 'boolean',
tags: ['notebookLayout'],
default: false
Expand Down