[Pulp-list] --help standards for client tools

[Jason Dobies]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I tried to +1 this last night but e-mails to pulp-list from my iPhone
get punted. So I'm resending it because I'm pretty sure it didn't get
through.

On 09/26/2010 08:20 PM, 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


- -- 
Jason Dobies
RHCE# 805008743336126
Freenode: jdob
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.14 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJMoI7SAAoJEOMmcTqOSQHCtscH/iKBCfnczCi+ArSWW13C8P19
C60rRoJrI4kui7sLHeLULnEx3fT51KMwC1wVAJomjyVeQw485/k/912rkKqtwsm3
lXjzlemMX1kxGVQ41aDBaG0sTPu/VIvp5ub/KeKRfk3MuIexuFRpLX5FpeKs30Fv
e8lEznEkHhaoUMsAV6il7kjAEQlXE3mFp5TDkOTfxuPrqmLwImV1t7LlcAAC/nJU
vqtJcIKcstdsy/NNZ64GirxA40wD+jh3AYIEnGsvGKCx6n7uNMimRdGv/7WGBH8U
0xPHIOf8dceAMRAvvBB5OS9+SnoAS2SlOiUGj3zO2FjMHulYaf0WEumpVAR0KFk=
=vFZi
-----END PGP SIGNATURE-----