I was changing the subject slightly, sorry for the confusion.
I just meant that have a simple and advanced example would go a long
way towards making the CLI usage clear, and that default values are
less important there than a good example
Lloyd
On Oct 23, 2009, at 1:19 PM, Nandini Ektare wrote:
> Lloyd Chambers wrote:
>> To clarify my earlier comment—
>>
>> "If the user needs more info on any particular option, man page
>> should provide all the details needed"
>>
>> In my experience the issue is rarely understanding a particular
>> option, the major stumbling block is lack of a basic and advanced
>> *example* invocation.
> Not sure what you are trying to say. Probably we are saying the same
> thing. :)
>
> If I were to sum up my previous thoughts, it would run something like:
>
> Usage should be concise and precise. Though not a widely followed
> practice, merging usage and example seems convenient to me because
> then as a basic user I get a very good quick reference from the
> usage itself. At times, I have found it inconvenient to see the
> whole man page just for the examples; nonetheless I do expect of
> myself to see man page for any specific details especially when the
> text is lengthy.
> Getting to see the defaults then and there also makes up for v3 user
> experience degradation, if any, due to missing default values in
> domain.xml
>
> Anyway, my vote is inherently biased being very close to the
> product. So I'll save meself further typing ;-)