Skip to content

Document possible values of analytics command #15039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 15, 2019

Conversation

jbogarthyde
Copy link
Contributor

The possible values are in the JSON (and an error message) but are not mentioned in the doc.

This is probably true of all enum values - in the standard API doc, value types are automatically extracted into the doc, but since these are always strings, we don't do that. We should have a way to automatically include enumerated value descriptions, that would go into the arg description.

For now, I've put them into a long-description for the command.

@jbogarthyde jbogarthyde requested a review from hansl July 10, 2019 18:18
@jbogarthyde jbogarthyde self-assigned this Jul 10, 2019
@jbogarthyde jbogarthyde added area: @angular/cli effort1: easy (hours) freq1: low Only reported by a handful of users who observe it rarely target: patch This PR is targeted for the next patch release P5 The team acknowledges the request but does not plan to address it, it remains open for discussion severity2: inconvenient area: docs Related to the documentation labels Jul 10, 2019
@jbogarthyde
Copy link
Contributor Author

I need information about the "ci" value - how does it affect behavior?

@jbogarthyde jbogarthyde requested review from alan-agius4 and removed request for hansl July 15, 2019 16:37
@mgechev mgechev merged commit b5924fe into angular:master Jul 15, 2019
mgechev pushed a commit that referenced this pull request Jul 15, 2019
* docs: add possible values to ref doc for analytics command

* docs: add ci value
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: @angular/cli area: docs Related to the documentation effort1: easy (hours) freq1: low Only reported by a handful of users who observe it rarely P5 The team acknowledges the request but does not plan to address it, it remains open for discussion severity2: inconvenient target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants