Skip to content

Commit e293cb1

Browse files
alan-agius4clydin
authored andcommitted
docs(@angular/cli): minor updates to ng run description
Minor improvements of `ng run` docs (cherry picked from commit 89ab299)
1 parent 2c04f4a commit e293cb1

File tree

2 files changed

+8
-13
lines changed

2 files changed

+8
-13
lines changed

packages/angular/cli/src/commands/run/cli.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ export class RunCommandModule
3838

3939
const localYargs: Argv<RunCommandArgs> = argv
4040
.positional('target', {
41-
describe: 'The Architect target to run.',
41+
describe:
42+
'The Architect target to run provided in the the following format `project:target[:configuration]`.',
4243
type: 'string',
4344
demandOption: true,
4445
// Show only in when using --help and auto completion because otherwise comma seperated configuration values will be invalid.
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.
22
The CLI commands run Architect targets such as `build`, `serve`, `test`, and `lint`.
3-
Each named target has a default configuration, specified by an "options" object,
4-
and an optional set of named alternate configurations in the "configurations" object.
3+
Each named target has a default configuration, specified by an `options` object,
4+
and an optional set of named alternate configurations in the `configurations` object.
55

6-
For example, the "serve" target for a newly generated app has a predefined
7-
alternate configuration named "production".
6+
For example, the `serve` target for a newly generated app has a predefined
7+
alternate configuration named `production`.
88

9-
You can define new targets and their configuration options in the "architect" section
10-
of the `angular.json` file.
11-
If you do so, you can run them from the command line using the `ng run` command.
12-
Execute the command using the following format.
13-
14-
```
15-
ng run project:target[:configuration]
16-
```
9+
You can define new targets and their configuration options in the `architect` section
10+
of the `angular.json` file which you can run them from the command line using the `ng run` command.

0 commit comments

Comments
 (0)