Skip to content

Commit c99cef7

Browse files
alan-agius4clydin
alan-agius4
authored and
clydin
committed
docs: remove when true, when false from argument descriptions
It's confusing and redundant to use `When true` and `when false` in descriptions for a CLI arguments because specifying false/true is redundant in a command line argument flag and in most cases users will not do it. Example: `--foo=true` is the same as `--foo` `--foo=false` is the same as `--no-foo`
1 parent ca69c8c commit c99cef7

File tree

23 files changed

+86
-86
lines changed

23 files changed

+86
-86
lines changed

‎packages/angular/cli/commands/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
},
3232
"global": {
3333
"type": "boolean",
34-
"description": "When true, accesses the global configuration in the caller's home directory.",
34+
"description": "Access the global configuration in the caller's home directory.",
3535
"default": false,
3636
"aliases": ["g"]
3737
}

‎packages/angular/cli/commands/definitions.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
]
2222
},
2323
"prod": {
24-
"description": "Shorthand for \"--configuration=production\".\nWhen true, sets the build configuration to the production target.\nBy default, the production target is set up in the workspace configuration such that all builds make use of bundling, limited tree-shaking, and also limited dead code elimination.",
24+
"description": "Shorthand for \"--configuration=production\".\nSet the build configuration to the production target.\nBy default, the production target is set up in the workspace configuration such that all builds make use of bundling, limited tree-shaking, and also limited dead code elimination.",
2525
"type": "boolean"
2626
}
2727
}
@@ -42,13 +42,13 @@
4242
"type": "boolean",
4343
"default": false,
4444
"aliases": [ "d" ],
45-
"description": "When true, runs through and reports activity without writing out results."
45+
"description": "Run through and reports activity without writing out results."
4646
},
4747
"force": {
4848
"type": "boolean",
4949
"default": false,
5050
"aliases": [ "f" ],
51-
"description": "When true, forces overwriting of existing files."
51+
"description": "Force overwriting of existing files."
5252
}
5353
}
5454
},
@@ -57,12 +57,12 @@
5757
"interactive": {
5858
"type": "boolean",
5959
"default": "true",
60-
"description": "When false, disables interactive input prompts."
60+
"description": "Enable interactive input prompts."
6161
},
6262
"defaults": {
6363
"type": "boolean",
6464
"default": "false",
65-
"description": "When true, disables interactive input prompts for options with a default."
65+
"description": "Disable interactive input prompts for options with a default."
6666
}
6767
}
6868
}

‎packages/angular/cli/commands/doc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"aliases": ["s"],
2525
"type": "boolean",
2626
"default": false,
27-
"description": "When true, searches all of angular.io. Otherwise, searches only API reference documentation."
27+
"description": "Search all of angular.io. Otherwise, searches only API reference documentation."
2828
},
2929
"version" : {
3030
"oneOf": [

‎packages/angular/cli/commands/new.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"type": "boolean",
2323
"default": false,
2424
"aliases": [ "v" ],
25-
"description": "When true, adds more details to output logging."
25+
"description": "Add more details to output logging."
2626
}
2727
},
2828
"required": []

‎packages/angular/cli/commands/update.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"type": "boolean"
4545
},
4646
"migrateOnly": {
47-
"description": "Only perform a migration, does not update the installed version.",
47+
"description": "Only perform a migration, do not update the installed version.",
4848
"oneOf": [
4949
{
5050
"type": "boolean"

‎packages/angular/cli/lib/config/schema.json

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
},
170170
"skipTests": {
171171
"type": "boolean",
172-
"description": "When true, does not create test files.",
172+
"description": "Do not create test files.",
173173
"default": false
174174
}
175175
}
@@ -211,7 +211,7 @@
211211
},
212212
"skipTests": {
213213
"type": "boolean",
214-
"description": "When true, does not create test files.",
214+
"description": "Do not create test files.",
215215
"default": false
216216
}
217217
}
@@ -258,7 +258,7 @@
258258
},
259259
"skipTests": {
260260
"type": "boolean",
261-
"description": "When true, does not create test files.",
261+
"description": "Do not create test files.",
262262
"default": false
263263
}
264264
}
@@ -273,7 +273,7 @@
273273
},
274274
"skipTests": {
275275
"type": "boolean",
276-
"description": "When true, does not create test files.",
276+
"description": "Do not create test files.",
277277
"default": false
278278
},
279279
"skipImport": {
@@ -299,7 +299,7 @@
299299
"properties": {
300300
"skipTests": {
301301
"type": "boolean",
302-
"description": "When true, does not create test files.",
302+
"description": "Do not create test files.",
303303
"default": false
304304
}
305305
}
@@ -1249,13 +1249,13 @@
12491249
},
12501250
"open": {
12511251
"type": "boolean",
1252-
"description": "When true, open the live-reload URL in default browser.",
1252+
"description": "Open the live-reload URL in default browser.",
12531253
"default": false,
12541254
"alias": "o"
12551255
},
12561256
"liveReload": {
12571257
"type": "boolean",
1258-
"description": "When true, reload the page on change using live-reload.",
1258+
"description": "Reload the page on change using live-reload.",
12591259
"default": true
12601260
},
12611261
"publicHost": {
@@ -1276,27 +1276,27 @@
12761276
},
12771277
"disableHostCheck": {
12781278
"type": "boolean",
1279-
"description": "When true, don't verify that connected clients are part of allowed hosts.",
1279+
"description": "Do not verify that connected clients are part of allowed hosts.",
12801280
"default": false
12811281
},
12821282
"hmr": {
12831283
"type": "boolean",
1284-
"description": "When true, enable hot module replacement.",
1284+
"description": "Enable hot module replacement.",
12851285
"default": false
12861286
},
12871287
"watch": {
12881288
"type": "boolean",
1289-
"description": "When true, rebuild on change.",
1289+
"description": "Rebuild on change.",
12901290
"default": true
12911291
},
12921292
"hmrWarning": {
12931293
"type": "boolean",
1294-
"description": "When true, show a warning when the --hmr option is enabled.",
1294+
"description": "Show a warning when the --hmr option is enabled.",
12951295
"default": true
12961296
},
12971297
"servePathDefaultWarning": {
12981298
"type": "boolean",
1299-
"description": "When true, show a warning when deploy-url/base-href use unsupported serve path values.",
1299+
"description": "Show a warning when deploy-url/base-href use unsupported serve path values.",
13001300
"default": true
13011301
},
13021302
"optimization": {
@@ -1308,12 +1308,12 @@
13081308
"properties": {
13091309
"scripts": {
13101310
"type": "boolean",
1311-
"description": "When true, enable optimization of the scripts output.",
1311+
"description": "Enable optimization of the scripts output.",
13121312
"default": true
13131313
},
13141314
"styles": {
13151315
"type": "boolean",
1316-
"description": "When true, enable optimization of the styles output.",
1316+
"description": "Enable optimization of the styles output.",
13171317
"default": true
13181318
}
13191319
},
@@ -1329,25 +1329,25 @@
13291329
"description": "Build using ahead-of-time compilation."
13301330
},
13311331
"sourceMap": {
1332-
"description": "When true, output sourcemaps.",
1332+
"description": "Output sourcemaps.",
13331333
"default": true,
13341334
"oneOf": [
13351335
{
13361336
"type": "object",
13371337
"properties": {
13381338
"scripts": {
13391339
"type": "boolean",
1340-
"description": "When true, output sourcemaps for all scripts.",
1340+
"description": "Output sourcemaps for all scripts.",
13411341
"default": true
13421342
},
13431343
"styles": {
13441344
"type": "boolean",
1345-
"description": "When true, output sourcemaps for all styles.",
1345+
"description": "Output sourcemaps for all styles.",
13461346
"default": true
13471347
},
13481348
"vendor": {
13491349
"type": "boolean",
1350-
"description": "When true, resolve vendor packages sourcemaps.",
1350+
"description": "Resolve vendor packages sourcemaps.",
13511351
"default": false
13521352
}
13531353
},
@@ -1360,11 +1360,11 @@
13601360
},
13611361
"vendorChunk": {
13621362
"type": "boolean",
1363-
"description": "When true, use a separate bundle containing only vendor libraries."
1363+
"description": "Use a separate bundle containing only vendor libraries."
13641364
},
13651365
"commonChunk": {
13661366
"type": "boolean",
1367-
"description": "When true, use a separate bundle containing code used across multiple bundles."
1367+
"description": "Use a separate bundle containing code used across multiple bundles."
13681368
},
13691369
"baseHref": {
13701370
"type": "string",
@@ -1376,11 +1376,11 @@
13761376
},
13771377
"verbose": {
13781378
"type": "boolean",
1379-
"description": "When true, add more details to output logging."
1379+
"description": "Add more details to output logging."
13801380
},
13811381
"progress": {
13821382
"type": "boolean",
1383-
"description": "When true, log progress to the console while building."
1383+
"description": "Log progress to the console while building."
13841384
}
13851385
},
13861386
"additionalProperties": false

‎packages/schematics/angular/application/schema.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@
2020
"x-prompt": "What name would you like to use for the application?"
2121
},
2222
"inlineStyle": {
23-
"description": "When true, includes styles inline in the root component.ts file. Only CSS styles can be included inline. Default is false, meaning that an external styles file is created and referenced in the root component.ts file.",
23+
"description": "Include styles inline in the root component.ts file. Only CSS styles can be included inline. Default is false, meaning that an external styles file is created and referenced in the root component.ts file.",
2424
"type": "boolean",
2525
"alias": "s",
2626
"x-user-analytics": 9
2727
},
2828
"inlineTemplate": {
29-
"description": "When true, includes template inline in the root component.ts file. Default is false, meaning that an external template file is created and referenced in the root component.ts file. ",
29+
"description": "Include template inline in the root component.ts file. Default is false, meaning that an external template file is created and referenced in the root component.ts file. ",
3030
"type": "boolean",
3131
"alias": "t",
3232
"x-user-analytics": 10
@@ -39,7 +39,7 @@
3939
},
4040
"routing": {
4141
"type": "boolean",
42-
"description": "When true, creates a routing NgModule.",
42+
"description": "Create a routing NgModule.",
4343
"default": false,
4444
"x-prompt": "Would you like to add Angular routing?",
4545
"x-user-analytics": 17
@@ -76,7 +76,7 @@
7676
"x-user-analytics": 5
7777
},
7878
"skipTests": {
79-
"description": "When true, does not create \"spec.ts\" test files for the application.",
79+
"description": "Do not create \"spec.ts\" test files for the application.",
8080
"type": "boolean",
8181
"default": false,
8282
"alias": "S",
@@ -85,10 +85,10 @@
8585
"skipPackageJson": {
8686
"type": "boolean",
8787
"default": false,
88-
"description": "When true, does not add dependencies to the \"package.json\" file."
88+
"description": "Do not add dependencies to the \"package.json\" file."
8989
},
9090
"minimal": {
91-
"description": "When true, creates a bare-bones project without any testing frameworks. (Use for learning purposes only.)",
91+
"description": "Create a bare-bones project without any testing frameworks. (Use for learning purposes only.)",
9292
"type": "boolean",
9393
"default": false,
9494
"x-user-analytics": 14
@@ -100,7 +100,7 @@
100100
},
101101
"lintFix": {
102102
"type": "boolean",
103-
"description": "When true, applies lint fixes after generating the application.",
103+
"description": "Apply lint fixes after generating the application.",
104104
"x-user-analytics": 15,
105105
"x-deprecated": "Use \"ng lint --fix\" directly instead."
106106
},

‎packages/schematics/angular/class/schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
},
3030
"skipTests": {
3131
"type": "boolean",
32-
"description": "When true, does not create \"spec.ts\" test files for the new class.",
32+
"description": "Do not create \"spec.ts\" test files for the new class.",
3333
"default": false,
3434
"x-user-analytics": 12
3535
},
@@ -41,7 +41,7 @@
4141
"lintFix": {
4242
"type": "boolean",
4343
"default": false,
44-
"description": "When true, applies lint fixes after generating the class.",
44+
"description": "Apply lint fixes after generating the class.",
4545
"x-user-analytics": 15,
4646
"x-deprecated": "Use \"ng lint --fix\" directly instead."
4747
}

‎packages/schematics/angular/component/schema.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@
3434
"alias": "b"
3535
},
3636
"inlineStyle": {
37-
"description": "When true, includes styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file.",
37+
"description": "Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file.",
3838
"type": "boolean",
3939
"default": false,
4040
"alias": "s",
4141
"x-user-analytics": 9
4242
},
4343
"inlineTemplate": {
44-
"description": "When true, includes template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.",
44+
"description": "Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.",
4545
"type": "boolean",
4646
"default": false,
4747
"alias": "t",
@@ -95,18 +95,18 @@
9595
},
9696
"skipTests": {
9797
"type": "boolean",
98-
"description": "When true, does not create \"spec.ts\" test files for the new component.",
98+
"description": "Do not create \"spec.ts\" test files for the new component.",
9999
"default": false,
100100
"x-user-analytics": 12
101101
},
102102
"flat": {
103103
"type": "boolean",
104-
"description": "When true, creates the new files at the top level of the current project.",
104+
"description": "Create the new files at the top level of the current project.",
105105
"default": false
106106
},
107107
"skipImport": {
108108
"type": "boolean",
109-
"description": "When true, does not import this component into the owning NgModule.",
109+
"description": "Do not import this component into the owning NgModule.",
110110
"default": false,
111111
"x-user-analytics": 18
112112
},
@@ -128,18 +128,18 @@
128128
"export": {
129129
"type": "boolean",
130130
"default": false,
131-
"description": "When true, the declaring NgModule exports this component.",
131+
"description": "The declaring NgModule exports this component.",
132132
"x-user-analytics": 19
133133
},
134134
"entryComponent": {
135135
"type": "boolean",
136136
"default": false,
137-
"description": "When true, the new component is the entry component of the declaring NgModule.",
137+
"description": "The new component is the entry component of the declaring NgModule.",
138138
"x-deprecated": "Since version 9.0.0 with Ivy, entryComponents is no longer necessary."
139139
},
140140
"lintFix": {
141141
"type": "boolean",
142-
"description": "When true, applies lint fixes after generating the component.",
142+
"description": "Apply lint fixes after generating the component.",
143143
"x-user-analytics": 15,
144144
"x-deprecated": "Use \"ng lint --fix\" directly instead."
145145
}

0 commit comments

Comments
 (0)