Add and edit docs for generate subcommands #12743
Conversation
jbogarthyde
added
effort2: medium (days)
state: WIP
area: docs
| @@ -15,18 +16,18 @@ | |||
| }, | |||
| "spec": { | |||
| "type": "boolean", | |||
| "description": "Specifies if a spec file is generated.", | |||
| "description": "When true (the default), generates a \"spec.ts\" test file for the new guard.", | |||
There was a problem hiding this comment.
Nit: would be nice to have the same descriptions for the same flag.
For instance sometimes, it is "When true, generates... and sometimes it is When true (the default), generates ..`
|
@jbogarthyde, Can you please rebase? |
jbogarthyde
force-pushed
the
jb-subcommand-doc
branch
2 times, most recently
from
249b8b4 to
1fa8658
Compare
jbogarthyde
force-pushed
the
jb-subcommand-doc
branch
from
67a8271 to
3c39525
Compare
| "properties": { | ||
| "projectRoot": { | ||
| "description": "The root directory of the new application.", | ||
| "description": "The root folder of the new app.", |
There was a problem hiding this comment.
just a small nit, but in general we use directory instead of folder as terminology
There was a problem hiding this comment.
Jury is out on this one. I tend to prefer folder.
@jenniferfell
The Author's Style Guide does not address the issue -- and in fact, that page uses "folder" 19 times and "directory" 12 times - sometimes in the same sentence.
From Google Developer's Style Guide:
directory, folder
If the context you're documenting (such as an IDE's GUI) uses one term or the other, use that term. If not, then use directory in a command-line context, and folder in a GUI context. When in doubt, default to directory.
I guess that means this reference doc should use directory.
|
Moved these commits to docs-preview branch - PR Docs preview #12837 |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
WIP - transfer edited doc content for generation schematics from draft to source files