Changing order in bzr help command text

John Arbash Meinel john at arbash-meinel.com
Mon Oct 29 16:36:17 GMT 2007


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

Daniel Watkins wrote:
> On Mon, 29 Oct 2007 14:33:54 +0000
> "Matthew Revell" <matthew.revell at canonical.com> wrote:
>> Would it be desirable to move the "aliases" and "see also" lines in
>> command-line help to the top of the output?
> I think 'aliases' might be of value, but I think that 'see also' should
> come after the main text.  It doesn't make sense, to me, to tell people
> where else to look for an answer before they know if they need to
> look elsewhere...
> 
>> I ask because longer descriptions can make the "aliases" and "see
>> also" easy to miss.
> Surely it's more likely that they will scroll of the top of the screen
> if moved to the top of a long description?
> 

Attached is a patch which does this. I didn't try to do any tests, etc. It was
mostly just to experiment with it.

And at the moment, I think it looks better at the top. With the other lines
that are similar.

% bzr help send
Purpose: Mail or create a merge-directive for submiting changes.
Usage:   bzr send [SUBMIT_BRANCH] [PUBLIC_BRANCH]
See also: merge
Options:
  -f ARG, --from=ARG    Branch to generate the submission from, rather than the
one containing the
...


This also makes it more obvious to users that they might use "bzr merge" to
merge the MD. Though "bzr help merge" should really mention that.

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.7 (Darwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFHJgwBJdeBCYSNAAMRAqfaAJ0Trlic8MSJuxq2gaIy5oBdBFV7pACcCcrT
Or807p4/5Udp3lOA0Egf1m8=
=h/iZ
-----END PGP SIGNATURE-----
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: help_text.diff
Url: https://lists.ubuntu.com/archives/bazaar/attachments/20071029/dfefe4d4/attachment.diff 


More information about the bazaar mailing list