Skip to content

Commit f5cf24e

Browse files
committed
docs(@schematics/angular): correct directory and entryFile option descriptions
The `ng new` `directory` option claimed the workspace is created in the current directory when the option is omitted, but a new directory named after the workspace is created instead. The library `entryFile` option described a path relative to the workspace root, but the value is a file name without the `.ts` extension that is placed in the library's `src` directory.
1 parent d542827 commit f5cf24e

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"entryFile": {
2020
"type": "string",
2121
"format": "path",
22-
"description": "The path to the library's public API file, relative to the workspace root. This file defines what parts of the library are accessible to applications that import it.",
22+
"description": "The name of the library's public API file, without the `.ts` extension, relative to the library's `src` directory. This file defines what parts of the library are accessible to applications that import it.",
2323
"default": "public-api"
2424
},
2525
"prefix": {

‎packages/schematics/angular/ng-new/schema.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"properties": {
99
"directory": {
1010
"type": "string",
11-
"description": "The directory where the new workspace and project should be created. If not specified, the workspace will be created in the current directory."
11+
"description": "The directory where the new workspace and project should be created. If not specified, a new directory named after the workspace is created in the current directory."
1212
},
1313
"name": {
1414
"description": "The name for the new workspace and the initial project. This name will be used for the root directory and various identifiers throughout the project.",

0 commit comments

Comments
 (0)