compress: linkify references to io.ByteReader

The special treatment of io.ByteReader is somewhat significant.
Linkify references to that type from documentation.

Change-Id: I77c06e4c6b957d107638e2ff2a4c58148b396ed3
Reviewed-on: https://go-review.googlesource.com/c/go/+/525016
Reviewed-by: Matthew Dempsky <mdempsky@google.com>
Run-TryBot: Joseph Tsai <joetsai@digital-static.net>
Reviewed-by: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Auto-Submit: Joseph Tsai <joetsai@digital-static.net>

diff --git a/src/compress/bzip2/bzip2.go b/src/compress/bzip2/bzip2.go
index 51054ccabc9dfa5348a3525d8c9a709abbcaca2e..8f88e384f2e901bb99d32597e8ddb5c78190e6a9 100644 (file)
--- a/src/compress/bzip2/bzip2.go
+++ b/src/compress/bzip2/bzip2.go
@@ -41,7 +41,7 @@ type reader struct {
 }
 
 // NewReader returns an io.Reader which decompresses bzip2 data from r.
-// If r does not also implement io.ByteReader,
+// If r does not also implement [io.ByteReader],
 // the decompressor may read more data than necessary from r.
 func NewReader(r io.Reader) io.Reader {
        bz2 := new(reader)

diff --git a/src/compress/flate/inflate.go b/src/compress/flate/inflate.go
index d7375f2f1f2bdfb942c845c7de419c6ab38932be..111bf4343ec19e6c1733d2f7426983d0e07600e7 100644 (file)
--- a/src/compress/flate/inflate.go
+++ b/src/compress/flate/inflate.go
@@ -798,7 +798,7 @@ func (f *decompressor) Reset(r io.Reader, dict []byte) error {
 
 // NewReader returns a new ReadCloser that can be used
 // to read the uncompressed version of r.
-// If r does not also implement io.ByteReader,
+// If r does not also implement [io.ByteReader],
 // the decompressor may read more data than necessary from r.
 // 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.

diff --git a/src/compress/gzip/gunzip.go b/src/compress/gzip/gunzip.go
index ba8de97e6acba44e142a23955d864f849c3d526a..f138ff70aa10e0b3a5854ab76ad8ebb396996e05 100644 (file)
--- a/src/compress/gzip/gunzip.go
+++ b/src/compress/gzip/gunzip.go
@@ -83,7 +83,7 @@ type Reader struct {
 }
 
 // NewReader creates a new Reader reading the given reader.
-// If r does not also implement io.ByteReader,
+// 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 Reader when done.

diff --git a/src/compress/lzw/reader.go b/src/compress/lzw/reader.go
index 18df97029f2ea449f414f3ae7edd37f6086373c3..0866e2f0cbf331ef412b383736083c732e988d85 100644 (file)
--- a/src/compress/lzw/reader.go
+++ b/src/compress/lzw/reader.go
@@ -241,7 +241,7 @@ func (r *Reader) Reset(src io.Reader, order Order, litWidth int) {
 
 // NewReader creates a new io.ReadCloser.
 // Reads from the returned io.ReadCloser read and decompress data from r.
-// If r does not also implement io.ByteReader,
+// 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.

diff --git a/src/compress/zlib/reader.go b/src/compress/zlib/reader.go
index 10954eaad784d58caa49cf8c706b50e32281caad..6b148bd29a826b6f704150caacd5bf355f08b8b7 100644 (file)
--- a/src/compress/zlib/reader.go
+++ b/src/compress/zlib/reader.go
@@ -66,7 +66,7 @@ type Resetter interface {
 
 // NewReader creates a new ReadCloser.
 // Reads from the returned ReadCloser read and decompress data from r.
-// If r does not implement io.ByteReader, the decompressor may read more
+// If r does not 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 done.
 //