When Todd asked me about this on Friday, the first thing i compared our CLI to was yum's and if you see yum's CLI it basically hold all the points that todd mentioned. I personally like help starting with capital letters, but without period at the end. But I said I can lean either way. I would suggest we pick the standard common tools in RHEL are using.
~ Prad ----- Original Message ----- From: "Jason L Connor" <[email protected]> To: "pulp-list" <[email protected]> Sent: Monday, September 27, 2010 12:01:13 PM GMT -05:00 US/Canada Eastern Subject: Re: [Pulp-list] --help standards for client tools On Sun, 2010-09-26 at 20:20 -0400, Todd B. Sanders wrote: > I'd like to establish some standards for the way we document --help > for our client tools. I am proposing the following simple rules: > > 1. all lower case, always. > 2. semi-colons to separate multiple thoughts. > 3. no periods. > 4. no abbreviations. > > For example, this will change our current --help from: > > --relativepath=RELATIVEPATH Relative path where the repo is stored and > exposed to > > clients. This defaults to feed path if not > specified. > > > To: > > --relativepath=RELATIVEPATH relative path where the repository is stored > and exposed to > > clients; this defaults to feed path if not > specified > > > Please yell if you object to any of this. I'll be modifying the current > implementation to conform to these new rules. > > -Todd > > > _______________________________________________ > Pulp-list mailing list > [email protected] > https://www.redhat.com/mailman/listinfo/pulp-list Yuck! I'm personally a fan of sentences in the help, and would like to see us standardize in the other direction. I think the all lower case and semi-colons looks too much like code instead of documentation. -- Jason L Connor Software Engineer Systems Management and Cloud Enablement Red Hat, Inc. +1.919.890.8331 RHCT #605010081634021 Freenode: linear _______________________________________________ Pulp-list mailing list [email protected] https://www.redhat.com/mailman/listinfo/pulp-list -- -- Pradeep Kilambi Red Hat Systems Management [email protected] Phone: +1 919 754 4285 RHCE/RHCDS # 805008680430554 _______________________________________________ Pulp-list mailing list [email protected] https://www.redhat.com/mailman/listinfo/pulp-list
