diff options
| author | Andrew Gerrand <adg@golang.org> | 2014-08-01 11:54:10 +1000 |
|---|---|---|
| committer | Andrew Gerrand <adg@golang.org> | 2014-08-01 11:54:10 +1000 |
| commit | 329d3ce984fdf2478f15e834076aa38957972e00 (patch) | |
| tree | e2a72b3f5befb0eeebce29238360d84a3272b1ed | |
| parent | 57435625e5037643f74a23b80b74bb60dac37125 (diff) | |
| download | go-329d3ce984fdf2478f15e834076aa38957972e00.tar.gz go-329d3ce984fdf2478f15e834076aa38957972e00.zip | |
compress/{gzip,zlib}: mention that Close flushes
Our other CloseFlushers (archive/tar, compress/flate) do mention this.
LGTM=dave, r
R=r, dave
CC=golang-codereviews
https://golang.org/cl/117430043
| -rw-r--r-- | src/pkg/compress/gzip/gzip.go | 3 | ||||
| -rw-r--r-- | src/pkg/compress/zlib/writer.go | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/src/pkg/compress/gzip/gzip.go b/src/pkg/compress/gzip/gzip.go index 3a0bf54e1b..5131d128e4 100644 --- a/src/pkg/compress/gzip/gzip.go +++ b/src/pkg/compress/gzip/gzip.go @@ -245,7 +245,8 @@ func (z *Writer) Flush() error { return z.err } -// Close closes the Writer. It does not close the underlying io.Writer. +// Close closes the Writer, flushing any unwritten data to the underlying +// io.Writer, but does not close the underlying io.Writer. func (z *Writer) Close() error { if z.err != nil { return z.err diff --git a/src/pkg/compress/zlib/writer.go b/src/pkg/compress/zlib/writer.go index fac7e15a7e..3b4313a8be 100644 --- a/src/pkg/compress/zlib/writer.go +++ b/src/pkg/compress/zlib/writer.go @@ -174,7 +174,8 @@ func (z *Writer) Flush() error { return z.err } -// Calling Close does not close the wrapped io.Writer originally passed to NewWriter. +// Close closes the Writer, flushing any unwritten data to the underlying +// io.Writer, but does not close the underlying io.Writer. func (z *Writer) Close() error { if !z.wroteHeader { z.err = z.writeHeader() |