Rev 2832: Doc corrections for index object in http://sourcefrog.net/bzr/pack-trivial
Martin Pool
mbp at sourcefrog.net
Thu Sep 20 08:37:59 BST 2007
At http://sourcefrog.net/bzr/pack-trivial
------------------------------------------------------------
revno: 2832
revision-id: mbp at sourcefrog.net-20070920073757-r8nk6moayp2aa3y9
parent: pqm at pqm.ubuntu.com-20070918045733-es6jch43pxvogvhj
committer: Martin Pool <mbp at sourcefrog.net>
branch nick: pack-trivial
timestamp: Thu 2007-09-20 17:37:57 +1000
message:
Doc corrections for index object
modified:
bzrlib/index.py index.py-20070712131115-lolkarso50vjr64s-1
=== modified file 'bzrlib/index.py'
--- a/bzrlib/index.py 2007-08-24 02:15:47 +0000
+++ b/bzrlib/index.py 2007-09-20 07:37:57 +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).
"""
More information about the bazaar-commits
mailing list