You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by Jonathan Robie <jo...@redhat.com> on 2010/12/08 23:38:49 UTC
How important is consistency in command line util options?
How important is consistency in options for Python command line utilities?
I'm thinking particularly of consistent syntax for options that are
supported in more than one utility. We use some options quite
consistently, e.g. --durable always means the same thing.
Broker addresses are specified in various ways:
-a
--broker-addr
--broker-address
a positional argument
Timeout can usually be specified as "-t" or "--timeout", but in
qpid-route, "-t" means "transport".
Should we care about this?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: How important is consistency in command line util options?
Posted by Lahiru Gunathilake <gl...@gmail.com>.
Hi Robie,
On Thu, Dec 9, 2010 at 4:08 AM, Jonathan Robie <jo...@redhat.com>wrote:
> How important is consistency in options for Python command line utilities?
>
> I'm thinking particularly of consistent syntax for options that are
> supported in more than one utility. We use some options quite consistently,
> e.g. --durable always means the same thing.
>
> Broker addresses are specified in various ways:
>
> -a
> --broker-addr
> --broker-address
> a positional argument
>
> Timeout can usually be specified as "-t" or "--timeout", but in qpid-route,
> "-t" means "transport".
+1 for keeping consistency with the command line options. I would propose
use same argument names in all the places and document all in one place.
I found it's extremely difficult to find the required document from our
documentation set(wiki etc), but hopefully there are documentations.
Thanks
Lahiru
>
Should we care about this?
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
>
Re: How important is consistency in command line util options?
Posted by Alan Conway <ac...@redhat.com>.
On 12/08/2010 05:38 PM, Jonathan Robie wrote:
> How important is consistency in options for Python command line utilities?
>
> I'm thinking particularly of consistent syntax for options that are supported in
> more than one utility. We use some options quite consistently, e.g. --durable
> always means the same thing.
>
> Broker addresses are specified in various ways:
>
> -a
> --broker-addr
> --broker-address
> a positional argument
>
> Timeout can usually be specified as "-t" or "--timeout", but in qpid-route, "-t"
> means "transport".
>
> Should we care about this?
>
Yep, we should go for consistency. I trip over the broker address
inconsistencies every time I use the management tools.
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
RE: How important is consistency in command line util options?
Posted by Steve Huston <sh...@riverace.com>.
Hi Jonathan,
> How important is consistency in options for Python command
> line utilities?
>
> I'm thinking particularly of consistent syntax for options that are
> supported in more than one utility. We use some options quite
> consistently, e.g. --durable always means the same thing.
Ok.
> Broker addresses are specified in various ways:
>
> -a
> --broker-addr
> --broker-address
> a positional argument
>
> Timeout can usually be specified as "-t" or "--timeout", but in
> qpid-route, "-t" means "transport".
These are not good from a user-friendliness perspective.
> Should we care about this?
Definitely. They should be consistent across all utilities, python or
otherwise.
-Steve
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org