compress: some minor corrections or adjustments for godoc link

Change-Id: Ic1fc777b9a4e8262851e27646d53a0ec4fe55b64
Reviewed-on: https://go-review.googlesource.com/c/go/+/535076
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Run-TryBot: shuang cui <imcusg@gmail.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Joseph Tsai <joetsai@digital-static.net>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
This commit is contained in:
cui fliter 2023-10-13 11:28:53 +08:00 committed by Gopher Robot
parent 34f2365d88
commit dc12cb179a
5 changed files with 7 additions and 7 deletions

View File

@ -32,7 +32,7 @@ func newBitReader(r io.Reader) bitReader {
// ReadBits64 reads the given number of bits and returns them in the // ReadBits64 reads the given number of bits and returns them in the
// least-significant part of a uint64. In the event of an error, it returns 0 // least-significant part of a uint64. In the event of an error, it returns 0
// and the error can be obtained by calling [bitReader.Err](). // and the error can be obtained by calling bitReader.Err().
func (br *bitReader) ReadBits64(bits uint) (n uint64) { func (br *bitReader) ReadBits64(bits uint) (n uint64) {
for bits > br.bits { for bits > br.bits {
b, err := br.r.ReadByte() b, err := br.r.ReadByte()

View File

@ -803,7 +803,7 @@ func (f *decompressor) Reset(r io.Reader, dict []byte) error {
// The reader returns [io.EOF] after the final block in the DEFLATE stream has // 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. // been encountered. Any trailing data after the final block is ignored.
// //
// The ReadCloser returned by NewReader also implements [Resetter]. // The [io.ReadCloser] returned by NewReader also implements [Resetter].
func NewReader(r io.Reader) io.ReadCloser { func NewReader(r io.Reader) io.ReadCloser {
fixedHuffmanDecoderInit() fixedHuffmanDecoderInit()

View File

@ -88,7 +88,7 @@ type Reader struct {
// //
// It is the caller's responsibility to call Close on the [Reader] when done. // It is the caller's responsibility to call Close on the [Reader] when done.
// //
// The Reader.Header fields will be valid in the [Reader] returned. // The [Reader.Header] fields will be valid in the [Reader] returned.
func NewReader(r io.Reader) (*Reader, error) { func NewReader(r io.Reader) (*Reader, error) {
z := new(Reader) z := new(Reader)
if err := z.Reset(r); err != nil { if err := z.Reset(r); err != nil {

View File

@ -70,7 +70,7 @@ type Resetter interface {
// data than necessary from r. // data than necessary from r.
// It is the caller's responsibility to call Close on the ReadCloser when done. // It is the caller's responsibility to call Close on the ReadCloser when done.
// //
// The ReadCloser returned by NewReader also implements [Resetter]. // The [io.ReadCloser] returned by NewReader also implements [Resetter].
func NewReader(r io.Reader) (io.ReadCloser, error) { func NewReader(r io.Reader) (io.ReadCloser, error) {
return NewReaderDict(r, nil) return NewReaderDict(r, nil)
} }
@ -119,9 +119,9 @@ func (z *reader) Read(p []byte) (int, error) {
return n, io.EOF return n, io.EOF
} }
// Calling Close does not close the wrapped io.Reader originally passed to [NewReader]. // Calling Close does not close the wrapped [io.Reader] originally passed to [NewReader].
// In order for the ZLIB checksum to be verified, the reader must be // In order for the ZLIB checksum to be verified, the reader must be
// fully consumed until the io.EOF. // fully consumed until the [io.EOF].
func (z *reader) Close() error { func (z *reader) Close() error {
if z.err != nil && z.err != io.EOF { if z.err != nil && z.err != io.EOF {
return z.err return z.err