]> Cypherpunks repositories - gostls13.git/commit
compress/flate,compress/lzw: fix incorrect godoc links
authorOlivier Mengué <olivier.mengue@gmail.com>
Thu, 6 Mar 2025 08:23:15 +0000 (09:23 +0100)
committerGopher Robot <gobot@golang.org>
Fri, 7 Mar 2025 19:33:01 +0000 (11:33 -0800)
commitd7e5cd5851f9fea4512c20cf275d979516828521
tree6753bed2d00aad45d27376520300a1e883dda0f6
parentb4a333fea588b0df6f441f0e9838cff9338c71c4
compress/flate,compress/lzw: fix incorrect godoc links

Fix incorrect godoc links related to the use of the name "Reader" for
different things in the various compress/* packages:
- in compress/flate Reader is the interface describing the underlying reader,
  not the decompressor as in other packages, so "returned reader" must
  not be linked to Reader.
- in compress/lzw and compress/gzip Reader is the decompressor, not the
  interface of the underlying reader, so "underlying reader" must not
  be linked to Reader.

With this patch the formatting of "underlying reader" and "returned
reader" is consistent accross compress/* packages.

Change-Id: Iea315fd5ee5b6c177855693d68841f3709a382cf
Reviewed-on: https://go-review.googlesource.com/c/go/+/655335
Reviewed-by: Junyang Shao <shaojunyang@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
src/compress/flate/deflate.go
src/compress/flate/inflate.go
src/compress/gzip/gunzip.go
src/compress/lzw/reader.go