[MERGE] Hook documentation

Michael Ernst mernst at alum.mit.edu
Mon Oct 20 10:30:18 BST 2008


Andrew-

Thanks for your comments and clarifications on my patch; I appreciate them.

I have incorporated them all in the attached merge directive, except for
one:

> > The first parameter ``'post_push'``
> 
> I'm not sure that the markup of $,1r|(B``'post_push'``$,1r}(B makes sense $,1rt(B why include
> single quotes here, inside the monospaced text?

This formatting is retained from before my patch.  I presume it's because
that's the actual parameter is a single-quoted 9-character string, and the
text is referring to the actual argument.

    branch.Branch.hooks.install_named_hook('post_push', post_push_hook,
                                     'My post_push hook')

(Actually, "argument" may be a better term than "parameter", if Python
doesn't have some different convention for the terms.  A standard
convention is "actual argument", "formal parameter".)

                    -Michael Ernst

-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: doc-hooks.patch
Url: https://lists.ubuntu.com/archives/bazaar/attachments/20081020/9172d43a/attachment.diff 


More information about the bazaar mailing list