trivial: minor changes to in-line comments -- mark plaintext-hash-tree as obsolete
authorZooko O'Whielacronx <zooko@zooko.com>
Sat, 10 Jan 2009 21:56:01 +0000 (14:56 -0700)
committerZooko O'Whielacronx <zooko@zooko.com>
Sat, 10 Jan 2009 21:56:01 +0000 (14:56 -0700)
src/allmydata/immutable/upload.py
src/allmydata/interfaces.py

index 41b338e33f4bb38cd64eb4831c38c222e6af0c64..5c3c759aab63ce3511dcc746afe44ee4bb882c38 100644 (file)
@@ -683,7 +683,7 @@ class CHKUploader:
         return d
 
     def abort(self):
-        """Call this is the upload must be abandoned before it completes.
+        """Call this if the upload must be abandoned before it completes.
         This will tell the shareholders to delete their partial shares. I
         return a Deferred that fires when these messages have been acked."""
         if not self._encoder:
index 98553ab1597390b7369d4e106e5018aa44570e1b..18b300719ffa5a0baafd96129446319cc6d64816 100644 (file)
@@ -1330,7 +1330,7 @@ class IEncryptedUploadable(Interface):
         plaintext hashes, but don't need the redundant encrypted data)."""
 
     def get_plaintext_hashtree_leaves(first, last, num_segments):
-        """Get the leaf nodes of a merkle hash tree over the plaintext
+        """OBSOLETE; Get the leaf nodes of a merkle hash tree over the plaintext
         segments, i.e. get the tagged hashes of the given segments. The
         segment size is expected to be generated by the IEncryptedUploadable
         before any plaintext is read or ciphertext produced, so that the
@@ -1350,7 +1350,7 @@ class IEncryptedUploadable(Interface):
         """
 
     def get_plaintext_hash():
-        """Get the hash of the whole plaintext.
+        """OBSOLETE; Get the hash of the whole plaintext.
 
         This returns a Deferred which fires with a tagged SHA-256 hash of the
         whole plaintext, obtained from hashutil.plaintext_hash(data).