Improving the consistency of extensions synopses

Martin Geisler mg at lazybytes.net
Sun Jun 21 17:20:22 CDT 2009


Cedric Duval <cedricduval at free.fr> writes:

> Martin Geisler wrote:
>> All good! I hope you can keep track of all the suggestions :-)
>
> So I tried to synthesize the discussions, trying as much as possible
> to consistently:
>  - use a present tense predicate followed by a direct object
>  - keep simple and to the point, leaving details for the long help
>    (width is constrained, possibly even more so for translations)

I've pushed 9be824115ee8 which uses the textwrap module to wrap the
descriptions like we do for commandline argument descriptions.

But this is mostly for translations -- I agree that we should strive to
keep the short description short.

>  - rather tell about the specific functionality brought, than how
>    it will be provided (command or hook)

Very nice.

> Here is what we have:
>
>  acl             control access to a repository using simple hooks
>  bookmarks       track a line of development with movable markers
>  bugzilla        integrate Mercurial with a Bugzilla bug tracker
>  children        display children changesets
>  churn           display statistics about repository history
>  color           provide a color output to some commands

I would go for 'add color' instead of 'provide a color'

-- 
Martin Geisler

VIFF (Virtual Ideal Functionality Framework) brings easy and efficient
SMPC (Secure Multiparty Computation) to Python. See: http://viff.dk/.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 196 bytes
Desc: not available
Url : http://selenic.com/pipermail/mercurial-devel/attachments/20090622/6ab5da72/attachment.pgp 


More information about the Mercurial-devel mailing list