← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-09-20 09:00:26 UTC
  • mfrom: (2831.4.1 pack-trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20070920090026-ly0kde313r1ul2bu
(mbp) index docstring corrections

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
317
317
    def iter_all_entries(self):
318
318
        """Iterate over all keys within the index.
319
319
 
320
 
        :return: An iterable of (key, value) or (key, value, reference_lists).
 
320
        :return: An iterable of (index, key, value) or (index, key, value, reference_lists).
321
321
            The former tuple is used when there are no reference lists in the
322
322
            index, making the API compatible with simple key:value index types.
323
323
            There is no defined order for the result iteration - it will be in
510
510
        Duplicate keys across child indices are presumed to have the same
511
511
        value and are only reported once.
512
512
 
513
 
        :return: An iterable of (key, reference_lists, value). There is no
514
 
            defined order for the result iteration - it will be in the most
515
 
            efficient order for the index.
 
513
        :return: An iterable of (index, key, reference_lists, value).
 
514
            There is no defined order for the result iteration - it will be in
 
515
            the most efficient order for the index.
516
516
        """
517
517
        seen_keys = set()
518
518
        for index in self._indices:
528
528
        value and are only reported once.
529
529
 
530
530
        :param keys: An iterable providing the keys to be retrieved.
531
 
        :return: An iterable of (key, reference_lists, value). There is no
 
531
        :return: An iterable of (index, key, reference_lists, value). There is no
532
532
            defined order for the result iteration - it will be in the most
533
533
            efficient order for the index.
534
534
        """
610
610
    def iter_all_entries(self):
611
611
        """Iterate over all keys within the index
612
612
 
613
 
        :return: An iterable of (key, reference_lists, value). There is no
 
613
        :return: An iterable of (index, key, reference_lists, value). There is no
614
614
            defined order for the result iteration - it will be in the most
615
615
            efficient order for the index (in this case dictionary hash order).
616
616
        """
630
630
        """Iterate over keys within the index.
631
631
 
632
632
        :param keys: An iterable providing the keys to be retrieved.
633
 
        :return: An iterable of (key, reference_lists, value). There is no
 
633
        :return: An iterable of (index, key, reference_lists, value). There is no
634
634
            defined order for the result iteration - it will be in the most
635
635
            efficient order for the index (keys iteration order in this case).
636
636
        """
804
804
        iter_all_entries is implemented against the adapted index using
805
805
        iter_entries_prefix.
806
806
 
807
 
        :return: An iterable of (key, reference_lists, value). There is no
 
807
        :return: An iterable of (index, key, reference_lists, value). There is no
808
808
            defined order for the result iteration - it will be in the most
809
809
            efficient order for the index (in this case dictionary hash order).
810
810
        """