← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Aaron Bentley
  • Date: 2007-08-20 13:47:09 UTC
  • mto: This revision was merged to the branch mainline in revision 2735.
  • Revision ID: abentley@panoramicfeedback.com-20070820134709-66tbctep1hwz08kj
Update docstrings

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
735
735
    def iter_files_bytes(self, desired_files):
736
736
        """Iterate through file versions.
737
737
 
738
 
        The order in which files will be yielded is unspecified.
 
738
        Files will not necessarily be returned in the order they occur in
 
739
        desired_files.  No specific order is guaranteed.
 
740
 
739
741
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
740
 
        value that uniquely identifies the file version.  (Example: a
741
 
        TreeTransform trans_id.)
742
 
 
743
 
        The default implementation just does VersionedFile.get_lines().
 
742
        value supplied by the caller as part of desired_files.  It should
 
743
        uniquely identify the file version in the caller's context.  (Examples:
 
744
        an index number or a TreeTransform trans_id.)
 
745
 
 
746
        bytes_iterator is an iterable of bytestrings for the file.  The
 
747
        kind of iterable and length of the bytestrings are unspecified, but for
 
748
        this implementation, it is a list of lines produced by
 
749
        VersionedFile.get_lines().
 
750
 
744
751
        :param desired_files: a list of (file_id, revision_id, identifier)
745
 
            pairs
 
752
            triples
746
753
        """
747
754
        transaction = self.get_transaction()
748
755
        for file_id, revision_id, callable_data in desired_files: