Rev 4651: Review feedback. in http://bazaar.launchpad.net/~lifeless/bzr/2.0

[Robert Collins]

At http://bazaar.launchpad.net/~lifeless/bzr/2.0

------------------------------------------------------------
revno: 4651
revision-id: robertc at robertcollins.net-20090903003335-uzy5i9alm6thkz7l
parent: robertc at robertcollins.net-20090902222955-kwp6gjk0izbna7z1
committer: Robert Collins <robertc at robertcollins.net>
branch nick: 2.0
timestamp: Thu 2009-09-03 10:33:35 +1000
message:
  Review feedback.
=== modified file 'bzrlib/smart/repository.py'
--- a/bzrlib/smart/repository.py	2009-09-02 22:29:55 +0000
+++ b/bzrlib/smart/repository.py	2009-09-03 00:33:35 +0000
@@ -522,6 +522,11 @@
 class _ByteStreamDecoder(object):
     """Helper for _byte_stream_to_stream.
 
+    The expected usage of this class is via the function _byte_stream_to_stream
+    which creates a _ByteStreamDecoder, pops off the stream format and then
+    yields the output of record_stream(), the main entry point to
+    _ByteStreamDecoder.
+
     Broadly this class has to unwrap two layers of iterators:
     (type, substream)
     (substream details)