-
Notifications
You must be signed in to change notification settings - Fork 12k
Closed
Labels
P5The team acknowledges the request but does not plan to address it, it remains open for discussionThe team acknowledges the request but does not plan to address it, it remains open for discussionarea: @angular/cliarea: docsRelated to the documentationRelated to the documentationfeatureIssue that requests a new featureIssue that requests a new featurefreq1: lowOnly reported by a handful of users who observe it rarelyOnly reported by a handful of users who observe it rarelyseverity1: confusingtarget: patchThis PR is targeted for the next patch releaseThis PR is targeted for the next patch release
Milestone
Description
🚀 Feature request
Enumerated values for CLI command arguments and options need to be documented.
Command (mark with an x
)
ng analytics
(see #15039)
There might be more - have to do a search.
- [ ] new
- [ ] build
- [ ] serve
- [ ] test
- [ ] e2e
- [ ] generate
- [ ] add
- [ ] update
- [ ] lint
- [ ] xi18n
- [ ] run
- [ ] config
- [ ] help
- [ ] version
- [ ] doc
Description
The doc generated for CLI command args don't specify type (since they are all strings), but this means that they don't capture enumerated type values, which do need to be documented.
Describe the solution you'd like
To be consistent with other reference doc, the values should captured automatically and descriptions should be part of the arg or option description. Currently, I don't think there is room for them in the straight-text description of the arg itself -- should be markdown to accommodate a bullet list.
Describe alternatives you've considered
We can list and describe them in the command's long description (as in PR 15039)
Metadata
Metadata
Assignees
Labels
P5The team acknowledges the request but does not plan to address it, it remains open for discussionThe team acknowledges the request but does not plan to address it, it remains open for discussionarea: @angular/cliarea: docsRelated to the documentationRelated to the documentationfeatureIssue that requests a new featureIssue that requests a new featurefreq1: lowOnly reported by a handful of users who observe it rarelyOnly reported by a handful of users who observe it rarelyseverity1: confusingtarget: patchThis PR is targeted for the next patch releaseThis PR is targeted for the next patch release