[PATCH 2 of 8] histedit document the makedest function

[pierre-yves.david at logilab.fr]

# HG changeset patch
# User Pierre-Yves David <pierre-yves.david at ens-lyon.org>
# Date 1348180222 -7200
# Node ID 97ee214c11df224bbb9775af4b57e4e7ad83aebd
# Parent  15743c1683b3b5a854342623e818af76d9e62067
histedit document the makedest function

diff --git a/hgext/histedit.py b/hgext/histedit.py
--- a/hgext/histedit.py
+++ b/hgext/histedit.py
@@ -304,10 +304,16 @@ def message(ui, repo, ctx, ha, opts):
     # We didn't make an edit, so just indicate no replaced nodes
     return newctx, [new], [], []
 
 
 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]
     line = 'pick %s %d %s' % (c.hex()[:12], c.rev(), summary)
     return line[:80]  # trim to 80 chars so it's not stupidly wide in my editor