[MERGE] concise help for commands by default

Ian Clatworthy ian.clatworthy at internode.on.net
Fri Feb 6 15:28:27 GMT 2009


Ben Finney wrote:
> Ian Clatworthy <ian.clatworthy at internode.on.net> writes:
> 
>> As discussed on the mailing list recently, the help for commands
>> should be concise by default with "bzr help -v xxx" being used to
>> see the detailed information.
> 
> […]
> 
>> === modified file 'bzrlib/commands.py'
>> --- bzrlib/commands.py	2009-02-04 04:10:14 +0000
>> +++ bzrlib/commands.py	2009-02-06 08:06:04 +0000
>> @@ -326,7 +326,7 @@
>>          return s
>>  
>>      def get_help_text(self, additional_see_also=None, plain=True,
>> -                      see_also_as_links=False):
>> +                      see_also_as_links=False, verbose=True):
> 
> Shouldn't that be ‘verbose=False’?

It doesn't need to be, no. In fact, I think it's better to keep
verbose=True at *this* level of the API and not change behaviour
for existing API clients. For example, if a GUI tool were calling
this method and displaying the help in a scrolling window, it
would be rude to start showing concise help all of a sudden
(and refer to bzr help -v) when that isn't appropriate for GUI
tool users.

Ian C.



More information about the bazaar mailing list