Rev 3242: Cleanup documentation in http://bzr.arbash-meinel.com/branches/bzr/1.3-dev/annotate_cleanup

[John Arbash Meinel]

At http://bzr.arbash-meinel.com/branches/bzr/1.3-dev/annotate_cleanup

------------------------------------------------------------
revno: 3242
revision-id:john at arbash-meinel.com-20080305175657-idb7b5yyis2agiz2
parent: john at arbash-meinel.com-20080305174846-mlcmszy3gbntuowj
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: annotate_cleanup
timestamp: Wed 2008-03-05 17:56:57 +0000
message:
  Cleanup documentation
modified:
  bzrlib/knit.py                 knit.py-20051212171256-f056ac8f0fbe1bd9
-------------- next part --------------
=== modified file 'bzrlib/knit.py'
--- a/bzrlib/knit.py	2008-03-05 17:48:46 +0000
+++ b/bzrlib/knit.py	2008-03-05 17:56:57 +0000
@@ -1790,8 +1790,18 @@
         """Get the method, index_memo and compression parent for version_ids.
 
         :param version_ids: An iterable of version_ids.
-        :return: A dict of version_id:(method, index_memo, compression_parent,
-            parents, noeol).
+        :return: A dict of version_id:(index_memo, compression_parent,
+                                       parents, record_details).
+            index_memo
+                opaque structure to pass to read_records to extract the raw
+                data
+            compression_parent
+                Content that this record is built upon, may be None
+            parents
+                Logical parents of this node
+            record_details
+                extra information about the content which needs to be passed to
+                Factory.parse_record
         """
         result = {}
         entries = self._get_entries(self._version_ids_to_keys(version_ids), True)
@@ -2303,8 +2313,18 @@
         """Get the method, index_memo and compression parent for version_ids.
 
         :param version_ids: An iterable of version_ids.
-        :return: A dict of version_id:(method, index_memo, compression_parent,
-            parents, noeol).
+        :return: A dict of version_id:(index_memo, compression_parent,
+                                       parents, record_details).
+            index_memo
+                opaque structure to pass to read_records to extract the raw
+                data
+            compression_parent
+                Content that this record is built upon, may be None
+            parents
+                Logical parents of this node
+            record_details
+                extra information about the content which needs to be passed to
+                Factory.parse_record
         """
         result = {}
         for version_id in version_ids: