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

Tool help standardization #565

Closed
subfuzion opened this issue Dec 13, 2016 · 2 comments
Closed

Tool help standardization #565

subfuzion opened this issue Dec 13, 2016 · 2 comments

Comments

@subfuzion
Copy link
Contributor

subfuzion commented Dec 13, 2016

  • All of our tools should display help in the same format as the CLI.
  • All command and option help descriptions should start with an uppercase letter to look consistent. Linux tools are pretty inconsistent (even gnu programs, like gcc and yacc, aren't consistent). It's not that any one format is best, but we should at least strive for consistency among our own tools. If we end a description with a period, then all descriptions should end with a period (and vice versa).
@neha-viswanathan
Copy link
Contributor

neha-viswanathan commented Dec 13, 2016

There is a difference in the usage message for certain commands. Need a consensus on deciding what should Use contain?

var StackCmd = &cobra.Command{
	Use:   "stack operations",
	Short: "Stack operations",
       ....
var ServiceCmd = &cobra.Command{
	Use:   "service",
	Short: "Manage services",
        ....

@ndegory
Copy link
Contributor

ndegory commented Dec 14, 2016

@neha-viswanathan IMO and based on the official doc, Use should be the binary/command name, Short should be a few words description, and Long can be a multiline description.

neha-viswanathan pushed a commit that referenced this issue Dec 14, 2016
neha-viswanathan pushed a commit that referenced this issue Dec 15, 2016
subfuzion pushed a commit that referenced this issue Dec 16, 2016
* Fix for issues #547,#561,#565

* removed capitalized error messages
subfuzion pushed a commit that referenced this issue Dec 19, 2016
neha-viswanathan pushed a commit that referenced this issue Dec 19, 2016
* Fix for issues #547,#561,#565

* minor cleanup
subfuzion added a commit that referenced this issue Dec 30, 2016
* Amp cleanup (#603)

* Fix for issues #547,#561,#565

* minor cleanup

* updated changelog for AMP 0.4.0 (#602)

* updated changelog for 0.4.0 (partial)

* add fr changelog

* add jgj changelog

* added nv changelog

* add missing changelog for 0.3.0
subfuzion added a commit that referenced this issue Dec 30, 2016
* commit server,agents,clients, AMP Bootstrap and fixes reports (#519)

* add bootstrap feature to AMP cluster CLI (#306)

* update vendors (huge diff)

* serverless prototype (#539)

* Amp cleanup (#603)

* Fix for issues #547,#561,#565

* minor cleanup

* commit server,agents,clients, AMP Bootstrap and fixes reports (#519)

* add bootstrap feature to AMP cluster CLI (#306)

* update vendors (huge diff)

* serverless prototype (#539)

* Amp version more useful info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants