histedit document the makedest function
authorPierre-Yves David <pierre-yves.david@ens-lyon.org>
Fri, 21 Sep 2012 00:30:22 +0200
changeset 17641 811a657fae48
parent 17640 2d750e885512
child 17642 bea381c16809
histedit document the makedest function
hgext/histedit.py
--- a/hgext/histedit.py	Fri Sep 21 00:30:07 2012 +0200
+++ b/hgext/histedit.py	Fri Sep 21 00:30:22 2012 +0200
@@ -306,6 +306,12 @@
 
 
 def makedesc(c):
+    """build a initial action line for a ctx `c`
+
+    line are in the form:
+
+      pick <hash> <rev> <summary>
+    """
     summary = ''
     if c.description():
         summary = c.description().splitlines()[0]