From 26245c0c536394fc911d873000ef4bfa2d2ebce2 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Wed, 14 Nov 2018 06:26:57 +0100 Subject: [PATCH] docs: update long descriptions for test, e2e and lint Closes #12930 --- packages/angular/cli/commands/e2e-long.md | 2 +- packages/angular/cli/commands/lint-long.md | 2 +- packages/angular/cli/commands/test-long.md | 2 ++ packages/angular/cli/commands/test.json | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 packages/angular/cli/commands/test-long.md diff --git a/packages/angular/cli/commands/e2e-long.md b/packages/angular/cli/commands/e2e-long.md index 028becbcde..6b651df713 100644 --- a/packages/angular/cli/commands/e2e-long.md +++ b/packages/angular/cli/commands/e2e-long.md @@ -1,2 +1,2 @@ Must be executed from within a workspace directory. -When a project name is not supplied, the configured default e2e project of the workspace is used. \ No newline at end of file +When a project name is not supplied, it will execute for all projects. \ No newline at end of file diff --git a/packages/angular/cli/commands/lint-long.md b/packages/angular/cli/commands/lint-long.md index 42bbc32f00..03917ffb25 100644 --- a/packages/angular/cli/commands/lint-long.md +++ b/packages/angular/cli/commands/lint-long.md @@ -1,4 +1,4 @@ Takes the name of the project, as specified in the `projects` section of the `angular.json` workspace configuration file. -When a project name is not supplied, uses the configured `defaultProject` of the workspace. +When a project name is not supplied, it will execute for all projects. The default linting tool is [TSLint](https://palantir.github.io/tslint/), and the default configuration is specified in the project's `tslint.json` file. \ No newline at end of file diff --git a/packages/angular/cli/commands/test-long.md b/packages/angular/cli/commands/test-long.md new file mode 100644 index 0000000000..64dae312ab --- /dev/null +++ b/packages/angular/cli/commands/test-long.md @@ -0,0 +1,2 @@ +Takes the name of the project, as specified in the `projects` section of the `angular.json` workspace configuration file. +When a project name is not supplied, it will execute for all projects. \ No newline at end of file diff --git a/packages/angular/cli/commands/test.json b/packages/angular/cli/commands/test.json index 8e800f9cad..3b330a9cb7 100644 --- a/packages/angular/cli/commands/test.json +++ b/packages/angular/cli/commands/test.json @@ -2,7 +2,7 @@ "$schema": "http://json-schema.org/schema", "$id": "ng-cli://commands/test.json", "description": "Runs unit tests in a project.", - "$longDescription": "", + "$longDescription": "./test-long.md", "$aliases": [ "t" ], "$scope": "in",