]> Cypherpunks repositories - gostls13.git/commitdiff
compress/zlib: add example to doc comment
authorRuss Cox <rsc@golang.org>
Tue, 19 Jan 2010 21:09:50 +0000 (13:09 -0800)
committerRuss Cox <rsc@golang.org>
Tue, 19 Jan 2010 21:09:50 +0000 (13:09 -0800)
Fixes #548.

R=r
CC=golang-dev, graycardinalster
https://golang.org/cl/190062

src/pkg/compress/zlib/reader.go

index c3a9d28ca603e6335328c6c177bda7751a354a16..357a8a337bf8a9b5de3ca5e2993d945ddb83b022 100644 (file)
@@ -2,8 +2,25 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The zlib package implements reading and writing of zlib
-// format compressed files, as specified in RFC 1950.
+/*
+The zlib package implements reading and writing of zlib
+format compressed data, as specified in RFC 1950.
+
+The implementation provides filters that uncompress during reading
+and compress during writing.  For example, to write compressed data
+to a buffer:
+
+       var b bytes.Buffer
+       w, err := zlib.NewDeflater(&b)
+       w.Write(strings.Bytes("hello, world\n"))
+       w.Close()
+
+and to read that data back:
+
+       r, err := zlib.NewInflater(&b)
+       io.Copy(os.Stdout, r)
+       r.Close()
+*/
 package zlib
 
 import (