From a29739145d8a46786d503bfc8a8ecf47a7381710 Mon Sep 17 00:00:00 2001 From: Joe Tsai Date: Mon, 12 Sep 2022 10:15:37 -0700 Subject: [PATCH] compress/flate: update NewReader documentation Calling close is no longer necessary. It was was originally necessary to cleanup goroutines spawned to decompress the stream. This has not been the case since CL 4548079. Update the documentation to mention how it handles trailing data after the end of the DEFLATE stream. Change-Id: Ieacba264230560713b7b8d604665223fd096f4ec Reviewed-on: https://go-review.googlesource.com/c/go/+/430377 Run-TryBot: Joseph Tsai Auto-Submit: Joseph Tsai TryBot-Result: Gopher Robot Reviewed-by: Ian Lance Taylor Reviewed-by: Than McIntosh --- src/compress/flate/inflate.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/compress/flate/inflate.go b/src/compress/flate/inflate.go index 49921398e2..7efd4477ed 100644 --- a/src/compress/flate/inflate.go +++ b/src/compress/flate/inflate.go @@ -789,8 +789,8 @@ func (f *decompressor) Reset(r io.Reader, dict []byte) error { // to read the uncompressed version of r. // If r does not also implement io.ByteReader, // the decompressor may read more data than necessary from r. -// It is the caller's responsibility to call Close on the ReadCloser -// when finished reading. +// The reader returns io.EOF after the final block in the DEFLATE stream has +// been encountered. Any trailing data after the final block is ignored. // // The ReadCloser returned by NewReader also implements Resetter. func NewReader(r io.Reader) io.ReadCloser {