Skip to content

Commit 5b3ee07

Browse files
jbogarthydealexeagle
authored andcommitted
docs: edit reference doc for update command
1 parent 22e401b commit 5b3ee07

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
Perform a basic update to v7 of the core framework and CLI by running the following command.
1+
Perform a basic update to the current stable release of the core framework and CLI by running the following command.
22

33
```
44
ng update @angular/cli @angular/core
55
```
66

7+
To update to the next beta or pre-release version, use the `--next=true` option.
8+
79
For detailed information and guidance on updating your application, see the interactive [Angular Update Guide](https://update.angular.io/).

packages/schematics/update/update/schema.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"type": "object",
66
"properties": {
77
"packages": {
8-
"description": "The names of package(s) to update.",
8+
"description": "The package or packages to update.",
99
"type": "array",
1010
"items": {
1111
"type": "string"
@@ -15,35 +15,35 @@
1515
}
1616
},
1717
"force": {
18-
"description": "If false, will error out if installed packages are incompatible with the update.",
18+
"description": "When false (the default), reports an error if installed packages are incompatible with the update.",
1919
"default": false,
2020
"type": "boolean"
2121
},
2222
"all": {
23-
"description": "Whether to update all packages in package.json.",
23+
"description": "When true, update all packages in `package.json`.",
2424
"default": false,
2525
"type": "boolean"
2626
},
2727
"next": {
28-
"description": "Use the largest version, including beta and RCs.",
28+
"description": "Update to the latest version, including beta and RCs.",
2929
"default": false,
3030
"type": "boolean"
3131
},
3232
"migrateOnly": {
33-
"description": "Only perform a migration, does not update the installed version.",
33+
"description": "Perform a migration, but do not update the installed version.",
3434
"default": false,
3535
"type": "boolean"
3636
},
3737
"from": {
38-
"description": "Version from which to migrate from. Only available with a single package being updated, and only on migration only.",
38+
"description": "When using `--migrateOnly` for a single package, the version of that package from which to migrate.",
3939
"type": "string"
4040
},
4141
"to": {
42-
"description": "Version up to which to apply migrations. Only available with a single package being updated, and only on migrations only. Requires from to be specified. Default to the installed version detected.",
42+
"description": "When using `--migrateOnly` for a single package, the version of that package to which to migrate.",
4343
"type": "string"
4444
},
4545
"registry": {
46-
"description": "The NPM registry to use.",
46+
"description": "The npm registry to use.",
4747
"type": "string",
4848
"oneOf": [
4949
{
@@ -55,7 +55,7 @@
5555
]
5656
},
5757
"verbose": {
58-
"description": "Display additional details during the update process.",
58+
"description": "When true, display additional details during the update process.",
5959
"type": "boolean"
6060
},
6161
"packageManager": {

0 commit comments

Comments
 (0)