Update doc strings for command reference #12520
Conversation
jenniferfell
changed the title
jbogarthyde
force-pushed
the
jb-cli-ref
branch
from
6422d20 to
3b33311
Compare
jbogarthyde
changed the title
| "description": "Opens the official Angular API documentation for a given keyword.", | ||
| "$longDescription": "", | ||
| "description": "Opens the Angular documentation in a browser, with a search for a given term.", | ||
| "$longDescription": "./doc.md, |
There was a problem hiding this comment.
moved long desc back into short desc
| "description": "Generates and/or modifies files based on a schematic.", | ||
| "$longDescription": "", | ||
| "description": "Creates, initializes, and modifies files to create a generic version of an app or app element in the given or default project, according to the given schematic.", | ||
| "$longDescription": "Takes the name of the project, as specified in the \"projects\" section of the angular.json workspace configuration file. \n When a project name is not supplied, the configured default project of the workspace is used.", |
There was a problem hiding this comment.
The generate command actually doesn't take the name of a project in the same way as the other commands. It is currently an outlier and we've been discussing the best path forward to potentially remedy the situation.
There was a problem hiding this comment.
$longDescription also needs to point to a separate file.
There was a problem hiding this comment.
No long description now.
I'm also trying to formulate better boilerplate for the ones that do take an optional project. Maybe we can add it to definitions.json
jbogarthyde
force-pushed
the
jb-cli-ref
branch
from
fb6b2b9 to
b59817d
Compare
jbogarthyde
force-pushed
the
jb-cli-ref
branch
from
890b0f1 to
9ef0a14
Compare
|
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. |
4 participants
This is an initial draft transferring content from google doc draft to JSON sources.
Basic command descriptions and generation schematic options included.
This is to meant to test the git and cli-doc build process as well.