aboutsummaryrefslogtreecommitdiff
path: root/src/compress
diff options
context:
space:
mode:
authorDiogo Pinela <diogoid7400@gmail.com>2018-03-13 20:44:51 +0000
committerBrad Fitzpatrick <bradfitz@golang.org>2018-03-13 20:58:19 +0000
commit0dfc740e6837b9ae14951f3b3b973879a3070ac7 (patch)
tree3f5f9411b9f6e2e00a49969d0616c07bd84da499 /src/compress
parent375280f1bbdd8443cd961dab0ce97f1ce80f7c92 (diff)
downloadgo-0dfc740e6837b9ae14951f3b3b973879a3070ac7.tar.gz
go-0dfc740e6837b9ae14951f3b3b973879a3070ac7.zip
compress/gzip, compress/zlib: fix Writer documentation inconsistencies
Fixes #24379. Change-Id: Ibdc763a0c2b56e26f4269f8be429880e34a2558f Reviewed-on: https://go-review.googlesource.com/100495 Reviewed-by: Joe Tsai <joetsai@google.com>
Diffstat (limited to 'src/compress')
-rw-r--r--src/compress/gzip/gzip.go2
-rw-r--r--src/compress/zlib/writer.go2
2 files changed, 2 insertions, 2 deletions
diff --git a/src/compress/gzip/gzip.go b/src/compress/gzip/gzip.go
index 0cc44c59e0..db9750dee2 100644
--- a/src/compress/gzip/gzip.go
+++ b/src/compress/gzip/gzip.go
@@ -41,7 +41,7 @@ type Writer struct {
// NewWriter returns a new Writer.
// Writes to the returned writer are compressed and written to w.
//
-// It is the caller's responsibility to call Close on the WriteCloser when done.
+// It is the caller's responsibility to call Close on the Writer when done.
// Writes may be buffered and not flushed until Close.
//
// Callers that wish to set the fields in Writer.Header must do so before
diff --git a/src/compress/zlib/writer.go b/src/compress/zlib/writer.go
index 1620c00c52..a7b219467e 100644
--- a/src/compress/zlib/writer.go
+++ b/src/compress/zlib/writer.go
@@ -38,7 +38,7 @@ type Writer struct {
// NewWriter creates a new Writer.
// Writes to the returned Writer are compressed and written to w.
//
-// It is the caller's responsibility to call Close on the WriteCloser when done.
+// It is the caller's responsibility to call Close on the Writer when done.
// Writes may be buffered and not flushed until Close.
func NewWriter(w io.Writer) *Writer {
z, _ := NewWriterLevelDict(w, DefaultCompression, nil)