languages/go
languages/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-09-04 23:44:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/go1.17: clarify that compress/lzw Reader and Writer types are new

Browse source 
For #26535
For #44513
For #46005

Change-Id: I70d3711ab6451a61b526abb3da8e91243f637656
Reviewed-on: https://go-review.googlesource.com/c/go/+/323273
Trust: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Joe Tsai <thebrokentoaster@gmail.com>
This commit is contained in:
Ian Lance Taylor 2021-05-27 16:12:12 -07:00
parent 193d514131
commit 639acdc833
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/go1.17.html
View file

@ -331,11 +331,16 @@ Do not send CLs removing the interior tags from such phrases.
<dl id="compress/lzw"><dt><a href="/pkg/compress/lzw/">compress/lzw</a></dt>
<dd>
<p><!-- CL 273667 -->
The new
<a href="/pkg/compress/lzw/#Reader.Reset"><code>Reader.Reset</code></a>
and
<a href="/pkg/compress/lzw/#Writer.Reset"><code>Writer.Reset</code></a>
methods allow reuse of a <code>Reader</code> or <code>Writer</code>.
The <a href="/pkg/compress/lzw/#NewReader"><code>NewReader</code></a>
function is guaranteed to return a value of the new
type <a href="/pkg/compress/lzw/#Reader"><code>Reader</code></a>,
and similarly <a href="/pkg/compress/lzw/#NewWriter"><code>NewWriter</code></a>
is guaranteed to return a value of the new
type <a href="/pkg/compress/lzw/#Writer"><code>Writer</code></a>.
These new types both implement a <code>Reset</code> method
(<a href="/pkg/compress/lzw/#Reader.Reset"><code>Reader.Reset</code></a>,
<a href="/pkg/compress/lzw/#Writer.Reset"><code>Writer.Reset</code></a>)
that allows reuse of the <code>Reader</code> or <code>Writer</code>.
</p>
</dd>
</dl><!-- compress/lzw -->