Skip to content
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

fix(@angular/cli): adding help descriptions #4887

Merged
merged 1 commit into from
Feb 23, 2017

Conversation

sumitarora
Copy link
Contributor

Shuld Fix: #4845

Copy link
Contributor

@filipesilva filipesilva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job getting these all in!

In the future we should make the command descriptions the source of truth for the wiki docs even, similar to how the completion command uses options to auto-generate shell scripts.

I've a couple of change requests:

  • Use oneLine (or similar, as needed) from the common-tags lib for multiline descriptions instead of concatenating strings.
  • Start every description with a capital letter, and end it with a period.
  • Remove flag to... (and similar) from descriptions. e.g. flag whether to build using Ahead of Time compilation -> build using Ahead of Time compilation. I know that's how it shows up in our doc but its pretty redundant.
  • If you have time, propagate your new description strings back to the wiki doc.

@sumitarora sumitarora force-pushed the feat-help-descriptions branch 3 times, most recently from ef03cae to 2a7295f Compare February 22, 2017 16:00
@sumitarora
Copy link
Contributor Author

@filipesilva Done the changes to make changes back to wiki will talk to @Brocco

@filipesilva
Copy link
Contributor

filipesilva commented Feb 22, 2017

Awesome, thanks!

@sumitarora sumitarora force-pushed the feat-help-descriptions branch 3 times, most recently from 00345fe to cda7804 Compare February 22, 2017 22:34
@sumitarora sumitarora changed the title fix(Help): adding help descriptions fix(@angular/cli): adding help descriptions Feb 22, 2017
@sumitarora sumitarora force-pushed the feat-help-descriptions branch from cda7804 to 7ebe4f0 Compare February 22, 2017 23:44
@hansl hansl merged commit 7ebe4f0 into angular:master Feb 23, 2017
hansl added a commit that referenced this pull request Feb 23, 2017
@sumitarora sumitarora deleted the feat-help-descriptions branch March 24, 2017 16:35
asnowwolf pushed a commit to asnowwolf/angular-cli that referenced this pull request Apr 12, 2017
@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 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add descriptions to CLI command options
4 participants