# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@ens-lyon.org>
# Date 1306281023 -7200
# Node ID 47ba990eff0e76c32295f34454f396d344a3f698
# Parent  91169d2d7f1b284ff9e20bcfb8761f1b587aad90
update doc

diff -r 91169d2d7f1b -r 47ba990eff0e 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: