Rev 2746: Fix docstrings for Index.iter_entries etc in http://sourcefrog.net/bzr/pack-repository

[Martin Pool]

At http://sourcefrog.net/bzr/pack-repository

------------------------------------------------------------
revno: 2746
revision-id: mbp at sourcefrog.net-20070829084144-p3h18xqaj1hkfzgm
parent: robertc at robertcollins.net-20070828221915-fkprmgth95yihpyw
committer: Martin Pool <mbp at sourcefrog.net>
branch nick: pack-repository
timestamp: Wed 2007-08-29 18:41:44 +1000
message:
  Fix docstrings for Index.iter_entries etc
modified:
  bzrlib/index.py                index.py-20070712131115-lolkarso50vjr64s-1
=== modified file 'bzrlib/index.py'
--- a/bzrlib/index.py	2007-08-24 22:36:01 +0000
+++ b/bzrlib/index.py	2007-08-29 08:41:44 +0000
@@ -317,7 +317,7 @@
     def iter_all_entries(self):
         """Iterate over all keys within the index.
 
-        :return: An iterable of (key, value) or (key, value, reference_lists).
+        :return: An iterable of (index, key, value) or (index, key, value, reference_lists).
             The former tuple is used when there are no reference lists in the
             index, making the API compatible with simple key:value index types.
             There is no defined order for the result iteration - it will be in
@@ -510,9 +510,9 @@
         Duplicate keys across child indices are presumed to have the same
         value and are only reported once.
 
-        :return: An iterable of (key, reference_lists, value). There is no
-            defined order for the result iteration - it will be in the most
-            efficient order for the index.
+        :return: An iterable of (index, key, reference_lists, value).
+            There is no defined order for the result iteration - it will be in
+            the most efficient order for the index.
         """
         seen_keys = set()
         for index in self._indices:
@@ -528,7 +528,7 @@
         value and are only reported once.
 
         :param keys: An iterable providing the keys to be retrieved.
-        :return: An iterable of (key, reference_lists, value). There is no
+        :return: An iterable of (index, key, reference_lists, value). There is no
             defined order for the result iteration - it will be in the most
             efficient order for the index.
         """
@@ -610,7 +610,7 @@
     def iter_all_entries(self):
         """Iterate over all keys within the index
 
-        :return: An iterable of (key, reference_lists, value). There is no
+        :return: An iterable of (index, key, reference_lists, value). There is no
             defined order for the result iteration - it will be in the most
             efficient order for the index (in this case dictionary hash order).
         """
@@ -630,7 +630,7 @@
         """Iterate over keys within the index.
 
         :param keys: An iterable providing the keys to be retrieved.
-        :return: An iterable of (key, reference_lists, value). There is no
+        :return: An iterable of (index, key, reference_lists, value). There is no
             defined order for the result iteration - it will be in the most
             efficient order for the index (keys iteration order in this case).
         """
@@ -804,7 +804,7 @@
         iter_all_entries is implemented against the adapted index using
         iter_entries_prefix.
 
-        :return: An iterable of (key, reference_lists, value). There is no
+        :return: An iterable of (index, key, reference_lists, value). There is no
             defined order for the result iteration - it will be in the most
             efficient order for the index (in this case dictionary hash order).
         """