update doc
authorPierre-Yves David <pierre-yves.david@ens-lyon.org>
Wed, 25 May 2011 01:50:23 +0200
changeset 11 47ba990eff0e
parent 10 91169d2d7f1b
child 12 6312fc525a54
update doc
states.py
--- a/states.py	Wed May 25 01:46:48 2011 +0200
+++ b/states.py	Wed May 25 01:50:23 2011 +0200
@@ -51,6 +51,9 @@
 
     @util.propertycache
     def trackheads(self):
+        """Do we need to track heads of changeset in this state ?
+
+        We don't need to track heads for the last state as this is repos heads"""
         return self.next is not None
 
     def __cmp__(self, other):
@@ -58,6 +61,7 @@
 
     @util.propertycache
     def _revsetheads(self):
+        """function to be used by revset to finds heads of this states"""
         assert self.trackheads
         def revsetheads(repo, subset, x):
             args = revset.getargs(x, 0, 0, 'publicheads takes no arguments')
@@ -68,6 +72,7 @@
 
     @util.propertycache
     def headssymbol(self):
+        """name of the revset symbols"""
         if self.trackheads:
             return "%sheads" % self.name
         else: