[Pulp-list] --help standards for client tools
Jason L Connor
jconnor at redhat.com
Mon Sep 27 16:01:13 UTC 2010
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
> Pulp-list at redhat.com
> 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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 490 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/pulp-list/attachments/20100927/dfa759ea/attachment.sig>
More information about the Pulp-list
mailing list