Merge pull request #510 from reddaisyy/main

chore: make some documents clearer

Author: Byron

examples/gzdecoder-read.rs

@@ -11,8 +11,8 @@ fn main() {
     println!("{}", decode_reader(bytes).unwrap());
 }
 
-// Uncompresses a Gz Encoded vector of bytes and returns a string or error
-// Here &[u8] implements Read
+// Uncompresses a Gz-encoded vector of bytes and returns a string or error
+// Here &[u8] implements the Read trait
 fn decode_reader(bytes: Vec<u8>) -> io::Result<String> {
     let mut gz = read::GzDecoder::new(&bytes[..]);
     let mut s = String::new();

src/zlib/write.rs

@@ -129,7 +129,7 @@ impl<W: Write> ZlibEncoder<W> {
     ///
     /// This will flush the underlying data stream and then return the contained
     /// writer if the flush succeeded.
-    /// The compressed stream will not closed but only flushed. This
+    /// The compressed stream will not be closed but only flushed. This
     /// means that obtained byte array can by extended by another deflated
     /// stream. To close the stream add the two bytes 0x3 and 0x0.
     ///