Update function descriptions updatehook
authorChristian Ebert <blacktrash@gmx.net>
Mon, 18 Dec 2006 12:10:05 +0100
branchupdatehook
changeset 32 b70b38b15fa4
parent 31 28e8bd971c02
child 33 ebb39c6a1476
Update function descriptions
hgkw/kwexpander.py
hgkw/pretxnkw.py
hgkw/updatekw.py
--- a/hgkw/kwexpander.py	Mon Dec 18 12:01:26 2006 +0100
+++ b/hgkw/kwexpander.py	Mon Dec 18 12:10:05 2006 +0100
@@ -5,7 +5,7 @@
 import re
 
 def expandkw(ui, repo, rev, cid, candidates, update=False):
-    '''Important: returns False on success, True on failure.'''
+    '''Expands logged <Dollar>Hg<Dollar> in working directory.'''
 
     # name of keyword encode filter:
     kwencodefilter = 'hgkwencode'
--- a/hgkw/pretxnkw.py	Mon Dec 18 12:01:26 2006 +0100
+++ b/hgkw/pretxnkw.py	Mon Dec 18 12:10:05 2006 +0100
@@ -5,7 +5,8 @@
 import sys
 
 def pretxnkw(ui, repo, hooktype, **args):
-    '''Important: returns False on success, True on failure.'''
+    '''Collects candidates for keyword expansion on commit
+    and passes them to kwexpander.'''
 
     if hooktype != 'pretxncommit':
         # bail out with error
--- a/hgkw/updatekw.py	Mon Dec 18 12:01:26 2006 +0100
+++ b/hgkw/updatekw.py	Mon Dec 18 12:10:05 2006 +0100
@@ -3,7 +3,8 @@
 import kwexpander
 
 def updatekw(ui, repo, hooktype, **args):
-    '''Important: returns False on success, True on failure.'''
+    '''Collects candidates for keyword expansion on update
+    and passes them to kwexpander.'''
 
     if hooktype != 'update':
         # bail out with error