From: Nadeem Vawda <nadeem.vawda@gmail.com>
Date: Thu, 21 Jun 2012 22:35:57 +0000 (+0200)
Subject: Tidy up comments from dd4f7d5c51c7 (zlib compression dictionary support).
X-Git-Tag: v3.3.0b1~166
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=cf5e1d82e3c0910f094727b6ef8e2a63da9ed8cf;p=python

Tidy up comments from dd4f7d5c51c7 (zlib compression dictionary support).
---

diff --git a/Lib/test/test_zlib.py b/Lib/test/test_zlib.py
index 904ac4df61..d637c2d685 100644
--- a/Lib/test/test_zlib.py
+++ b/Lib/test/test_zlib.py
@@ -427,24 +427,23 @@ class CompressObjectTestCase(BaseCompressTestCase, unittest.TestCase):
 
     def test_dictionary(self):
         h = HAMLET_SCENE
-        # build a simulated dictionary out of the words in HAMLET
+        # Build a simulated dictionary out of the words in HAMLET.
         words = h.split()
         random.shuffle(words)
         zdict = b''.join(words)
-        # use it to compress HAMLET
+        # Use it to compress HAMLET.
         co = zlib.compressobj(zdict=zdict)
         cd = co.compress(h) + co.flush()
-        # verify that it will decompress with the dictionary
+        # Verify that it will decompress with the dictionary.
         dco = zlib.decompressobj(zdict=zdict)
         self.assertEqual(dco.decompress(cd) + dco.flush(), h)
-        # verify that it fails when not given the dictionary
+        # Verify that it fails when not given the dictionary.
         dco = zlib.decompressobj()
         self.assertRaises(zlib.error, dco.decompress, cd)
 
     def test_dictionary_streaming(self):
-        # this is simulating the needs of SPDY to be able to reuse the same
-        #  stream object (with its compression state) between sets of compressed
-        #  headers.
+        # This simulates the reuse of a compressor object for compressing
+        # several separate data streams.
         co = zlib.compressobj(zdict=HAMLET_SCENE)
         do = zlib.decompressobj(zdict=HAMLET_SCENE)
         piece = HAMLET_SCENE[1000:1500]
diff --git a/Modules/zlibmodule.c b/Modules/zlibmodule.c
index 102740b2b0..a44ed0d19f 100644
--- a/Modules/zlibmodule.c
+++ b/Modules/zlibmodule.c
@@ -619,7 +619,7 @@ PyZlib_objdecompress(compobject *self, PyObject *args)
             RetVal = NULL;
             goto error;
         }
-        /* repeat the call to inflate! */
+        /* Repeat the call to inflate. */
         Py_BEGIN_ALLOW_THREADS
         err = inflate(&(self->zst), Z_SYNC_FLUSH);
         Py_END_ALLOW_THREADS