diff hgext/states.py @ 68:6f7824dbce24

[state] Update doc on the mutable property of state (and the way it's implemented)

--- a/hgext/states.py	Tue Sep 13 01:10:18 2011 +0200
+++ b/hgext/states.py	Tue Sep 13 20:24:44 2011 +0200
@@ -235,17 +235,23 @@
 Revset
 ......
 
-    We add new ``readyheads()`` and ``publishedheads()`` revset directives. This
-    returns the heads of each state **as if all of them were activated**.
+We add new ``readyheads()`` and ``publishedheads()`` revset directives. This
+returns the heads of each state **as if all of them were activated**.
 
-    XXX TODO - I would like to
+XXX TODO - I would like to
+
+- move the current ``<state>heads()`` directives to
+  _``<state>heads()``
 
-    - move the current ``<state>heads()`` directives to
-      _``<state>heads()``
+- add ``<state>heads()`` directives to that return the currently in used heads
+
+- add ``<state>()`` directives that match all node in a state.
 
-    - add ``<state>heads()`` directives to that return the currently in used heads
+Context
+.......
 
-    - add ``<state>()`` directives that match all node in a state.
+The ``context`` class gain a new method  ``states()`` that return a ``state`` object. The
+most notable property of this states object are ```name`` and ``mutable``.
 
 Other extensions
 ................
@@ -398,7 +404,7 @@
         """
         return cmp(self.properties, other.properties)
 
-    @util.propertycache
+    @property
     def mutable(self):
         return bool(self.properties & _MUTABLE)