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

Todd B. Sanders tsanders at redhat.com
Mon Sep 27 16:28:28 UTC 2010


  On 09/27/2010 12:07 PM, Jason Dobies wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
>> 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.
>>
> My problem with sentence structure is that most times, people aren't
> writing in full sentences in a CLI:
>
> Creates a new consumer.
>
> Isn't an actual sentence, so formatting it as such reads awkward. The
> other side of that is that forcing full sentences to fulfill this
> formatting desire will end up with a really verbose CLI --help, which is
> also cumbersome. That's what the man page is for.

+1

Just trying to align more with current RHEL cli tools (i.e. yum --help)

-Todd
>
> - -- 
> 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/
>
> iQEcBAEBAgAGBQJMoMFNAAoJEOMmcTqOSQHCnsQIALFA+X4DY6lsU4MDKRn/CQCQ
> OiguA0roFfng/x2ok7kRR8mxuaqG04P6qs7zGntwhguymRTOY+3R1Nn00O9h0aYS
> 6LR2qkOmbxGKyqeFktKTBpFu89MvYj55bMwjKd4GcpkJx1qWLMpHHIXCBW6fEjLZ
> rVM/L/VzqKvRTCGebOm1MVbz8pQ81TEKNOkVEIWyrUu87e0sm8mQtHwauwd5LaqG
> hEzHQk32Jn+o6yfOjAVB8SeXphzCmuDbyNTetL7FDGM9LuucgPmAQRFpoTFVNJVz
> CzVznc1rynKs8jrr/sITQFbxDkdipZTLVOOUudTHM5wdABOApj7Dl3yrk1hGP9Y=
> =fy9X
> -----END PGP SIGNATURE-----
>
> _______________________________________________
> Pulp-list mailing list
> Pulp-list at redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-list




More information about the Pulp-list mailing list