Rev 2914: Make the contract of HeadsCache.heads() more clear. in http://people.ubuntu.com/~robertc/baz2.0/graph

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/graph

------------------------------------------------------------
revno: 2914
revision-id: robertc at robertcollins.net-20071019034502-55zg0l4gvmucd1uw
parent: robertc at robertcollins.net-20071018013101-6zbs4utnk16q59fu
committer: Robert Collins <robertc at robertcollins.net>
branch nick: graph
timestamp: Fri 2007-10-19 13:45:02 +1000
message:
  Make the contract of HeadsCache.heads() more clear.
modified:
  bzrlib/graph.py                graph_walker.py-20070525030359-y852guab65d4wtn0-1
=== modified file 'bzrlib/graph.py'
--- a/bzrlib/graph.py	2007-10-18 01:31:01 +0000
+++ b/bzrlib/graph.py	2007-10-19 03:45:02 +0000
@@ -381,6 +381,10 @@
     def heads(self, keys):
         """Return the heads of keys.
 
+        This matches the API of Graph.heads(), specifically the return value is
+        a set which can be mutated, and ordering of the input is not preserved
+        in the output.
+
         :see also: Graph.heads.
         :param keys: The keys to calculate heads for.
         :return: A set containing the heads, which may be mutated without