From c150d0d42d7385c9aa32ffbff99573ada4916f4e Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Fri, 13 Jul 2018 15:28:27 -0700 Subject: [PATCH] Edit pass on new built-in extension comments (#54277) --- .../configuration-editing/package.nls.json | 2 +- extensions/css-language-features/README.md | 4 ++-- extensions/emmet/README.md | 9 ++------- extensions/git/README.md | 4 ++-- extensions/grunt/README.md | 7 ++++--- extensions/gulp/README.md | 7 ++++--- extensions/html-language-features/README.md | 4 ++-- .../html-language-features/package.nls.json | 2 +- extensions/jake/README.md | 7 ++++--- extensions/json-language-features/README.md | 4 ++-- .../markdown-language-features/README.md | 4 ++-- extensions/merge-conflict/README.md | 4 ++-- extensions/npm/README.md | 19 ++++++++++--------- extensions/php-language-features/README.md | 4 ++-- .../typescript-language-features/README.md | 4 ++-- .../node/extensionsWorkbenchService.ts | 2 +- 16 files changed, 43 insertions(+), 44 deletions(-) diff --git a/extensions/configuration-editing/package.nls.json b/extensions/configuration-editing/package.nls.json index b8c247a9de3..20a9c1af8b7 100644 --- a/extensions/configuration-editing/package.nls.json +++ b/extensions/configuration-editing/package.nls.json @@ -1,4 +1,4 @@ { "displayName": "Configuration Editing", - "description": "Provides capabilities (advanced IntelliSense, auto-fixing) in configuration files like settings, launch and extension recommendation files." + "description": "Provides capabilities (advanced IntelliSense, auto-fixing) in configuration files like settings, launch, and extension recommendation files." } \ No newline at end of file diff --git a/extensions/css-language-features/README.md b/extensions/css-language-features/README.md index 8c5995e5b2f..5a3fad4948b 100644 --- a/extensions/css-language-features/README.md +++ b/extensions/css-language-features/README.md @@ -1,6 +1,6 @@ -# Language Features for CSS, SCSS and LESS files. +# Language Features for CSS, SCSS, and LESS files -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features diff --git a/extensions/emmet/README.md b/extensions/emmet/README.md index 07b808b5f62..b755345f787 100644 --- a/extensions/emmet/README.md +++ b/extensions/emmet/README.md @@ -1,14 +1,9 @@ # Emmet integration in Visual Studio Code -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features See [Emmet in Visual Studio Code](https://code.visualstudio.com/docs/editor/emmet) to learn about the features of this extension. -Please read the [CONTRIBUTING.md](https://github.com/Microsoft/vscode/blob/master/extensions/emmet/CONTRIBUTING.md) file to learn how to contribute to this extension. - - - - - +Please read the [CONTRIBUTING.md](https://github.com/Microsoft/vscode/blob/master/extensions/emmet/CONTRIBUTING.md) file to learn how to contribute to this extension. \ No newline at end of file diff --git a/extensions/git/README.md b/extensions/git/README.md index 469f954eb1f..bd7a8ef26c2 100644 --- a/extensions/git/README.md +++ b/extensions/git/README.md @@ -1,7 +1,7 @@ # Git integration for Visual Studio Code -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features -Read [Git support in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support) to learn about features of this extension. \ No newline at end of file +See [Git support in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support) to learn about the features of this extension. \ No newline at end of file diff --git a/extensions/grunt/README.md b/extensions/grunt/README.md index 1bb90aedece..b97ff21b117 100644 --- a/extensions/grunt/README.md +++ b/extensions/grunt/README.md @@ -1,12 +1,13 @@ # Grunt - The JavaScript Task Runner -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features This extension supports running [Grunt](https://gruntjs.com/) tasks defined in a `gruntfile.js` file as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Grunt tasks with the name 'build', 'compile', or 'watch' are treated as build tasks. -To run Grunt tasks use the `Tasks` menu. +To run Grunt tasks, use the **Tasks** menu. ## Settings -- `grunt.autoDetect` enable detecting tasks from `Gruntfile.js` files, the default is `on`. + +- `grunt.autoDetect` - Enable detecting tasks from `gruntfile.js` files, the default is `on`. diff --git a/extensions/gulp/README.md b/extensions/gulp/README.md index 27a43967db7..42accc57541 100644 --- a/extensions/gulp/README.md +++ b/extensions/gulp/README.md @@ -1,12 +1,13 @@ # Gulp - Automate and enhance your workflow -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features This extension supports running [Gulp](https://gulpjs.com/) tasks defined in a `gulpfile.{js,ts}` file as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Gulp tasks with the name 'build', 'compile', or 'watch' are treated as build tasks. -To run Gulp tasks use the `Tasks` menu. +To run Gulp tasks, use the **Tasks** menu. ## Settings -- `gulp.autoDetect` enable detecting tasks from `gulpfile.{js,ts}` files, the default is `on`. + +- `gulp.autoDetect` - Enable detecting tasks from `gulpfile.{js,ts}` files, the default is `on`. diff --git a/extensions/html-language-features/README.md b/extensions/html-language-features/README.md index 58aa8a98d52..d2e78da0be9 100644 --- a/extensions/html-language-features/README.md +++ b/extensions/html-language-features/README.md @@ -1,6 +1,6 @@ -# Language Features for HTML. +# Language Features for HTML -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features diff --git a/extensions/html-language-features/package.nls.json b/extensions/html-language-features/package.nls.json index 4b59c6fba33..73c94b4acf6 100644 --- a/extensions/html-language-features/package.nls.json +++ b/extensions/html-language-features/package.nls.json @@ -1,6 +1,6 @@ { "displayName": "HTML Language Features", - "description": "Provides rich language support for HTML, Razor and Handlebar files.", + "description": "Provides rich language support for HTML, Razor, and Handlebar files", "html.format.enable.desc": "Enable/disable default HTML formatter", "html.format.wrapLineLength.desc": "Maximum amount of characters per line (0 = disable).", "html.format.unformatted.desc": "List of tags, comma separated, that shouldn't be reformatted. 'null' defaults to all tags listed at https://www.w3.org/TR/html5/dom.html#phrasing-content.", diff --git a/extensions/jake/README.md b/extensions/jake/README.md index 603ab4935e2..969c970def7 100644 --- a/extensions/jake/README.md +++ b/extensions/jake/README.md @@ -1,12 +1,13 @@ # Jake - JavaScript build tool -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features This extension supports running [Jake](http://jakejs.com/) tasks defined in a `Jakefile.js` file as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Jake tasks with the name 'build', 'compile', or 'watch' are treated as build tasks. -To run Jake tasks use the `Tasks` menu. +To run Jake tasks, use the **Tasks** menu. ## Settings -- `jake.autoDetect` enable detecting tasks from `Jakefile.js` files, the default is `on`. + +- `jake.autoDetect` - Enable detecting tasks from `Jakefile.js` files, the default is `on`. diff --git a/extensions/json-language-features/README.md b/extensions/json-language-features/README.md index 569c58a1967..2ff5e6e57d3 100644 --- a/extensions/json-language-features/README.md +++ b/extensions/json-language-features/README.md @@ -1,6 +1,6 @@ -# Language Features for JSON files. +# Language Features for JSON files -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features diff --git a/extensions/markdown-language-features/README.md b/extensions/markdown-language-features/README.md index 9ad8ef927dd..e80e9e886bb 100644 --- a/extensions/markdown-language-features/README.md +++ b/extensions/markdown-language-features/README.md @@ -1,6 +1,6 @@ -# Language Features for Markdown files. +# Language Features for Markdown files -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features diff --git a/extensions/merge-conflict/README.md b/extensions/merge-conflict/README.md index 51ef7193a00..8077ecd6517 100644 --- a/extensions/merge-conflict/README.md +++ b/extensions/merge-conflict/README.md @@ -1,7 +1,7 @@ # Merge Conflict -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features -Read [Merge Conflicts in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_merge-conflicts) to learn about features of this extension. +See [Merge Conflicts in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_merge-conflicts) to learn about features of this extension. diff --git a/extensions/npm/README.md b/extensions/npm/README.md index ecdd082a341..0b3961ff716 100644 --- a/extensions/npm/README.md +++ b/extensions/npm/README.md @@ -1,20 +1,21 @@ # Node npm -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features This extension supports running npm scripts defined in the `package.json` as [tasks](https://code.visualstudio.com/docs/editor/tasks). Scripts with the name 'build', 'compile', or 'watch' are treated as build tasks. -To run scripts as tasks you use the `Tasks` menu. +To run scripts as tasks, use the **Tasks** menu. -For more information about auto detection of Tasks pls see the [documentation](https://code.visualstudio.com/Docs/editor/tasks#_task-autodetection). +For more information about auto detection of Tasks, see the [documentation](https://code.visualstudio.com/Docs/editor/tasks#_task-autodetection). ## Settings -- `npm.autoDetect` enable detecting scripts as tasks, the default is `on`. -- `npm.runSilent` run npm script with the `--silent` option, the default is `false`. -- `npm.packageManager` the package manager used to run the scripts: `npm` or `yarn`, the default is `npm`. -- `npm.exclude` glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the **absolute path** of the package.json. For example, to exclude all test folders use '**/test/**'. -- `npm.enableScriptExplorer` enable an explorer view for npm scripts. -- `npm.scriptExplorerAction` the default click action: `open` or `run`, the default is `open`. + +- `npm.autoDetect` - Enable detecting scripts as tasks, the default is `on`. +- `npm.runSilent` - Run npm script with the `--silent` option, the default is `false`. +- `npm.packageManager` - The package manager used to run the scripts: `npm` or `yarn`, the default is `npm`. +- `npm.exclude` - Glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the **absolute path** of the package.json. For example, to exclude all test folders use '**/test/**'. +- `npm.enableScriptExplorer` - Enable an explorer view for npm scripts. +- `npm.scriptExplorerAction` - The default click action: `open` or `run`, the default is `open`. diff --git a/extensions/php-language-features/README.md b/extensions/php-language-features/README.md index 4252eecb1f1..c00be6a964e 100644 --- a/extensions/php-language-features/README.md +++ b/extensions/php-language-features/README.md @@ -1,6 +1,6 @@ -# Language Features for PHP files. +# Language Features for PHP files -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features diff --git a/extensions/typescript-language-features/README.md b/extensions/typescript-language-features/README.md index 75a3b2a017d..26942f9d460 100644 --- a/extensions/typescript-language-features/README.md +++ b/extensions/typescript-language-features/README.md @@ -1,6 +1,6 @@ -# Language Features for Typescript and Javascript files. +# Language Features for Typescript and Javascript files -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features diff --git a/src/vs/workbench/parts/extensions/node/extensionsWorkbenchService.ts b/src/vs/workbench/parts/extensions/node/extensionsWorkbenchService.ts index 4da398657fc..58ab86a9d58 100644 --- a/src/vs/workbench/parts/extensions/node/extensionsWorkbenchService.ts +++ b/src/vs/workbench/parts/extensions/node/extensionsWorkbenchService.ts @@ -245,7 +245,7 @@ class Extension implements IExtension { if (this.type === LocalExtensionType.System) { return TPromise.as(`# ${this.displayName || this.name} -**Notice** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. +**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled. ## Features ${this.description} `);