Skip to content

Commit 639acdc

Browse files
doc/go1.17: clarify that compress/lzw Reader and Writer types are new
For #26535 For #44513 For #46005 Change-Id: I70d3711ab6451a61b526abb3da8e91243f637656 Reviewed-on: https://go-review.googlesource.com/c/go/+/323273 Trust: Ian Lance Taylor <[email protected]> Reviewed-by: Joe Tsai <[email protected]>
1 parent 193d514 commit 639acdc

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

doc/go1.17.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -331,11 +331,16 @@ <h3 id="minor_library_changes">Minor changes to the library</h3>
331331
<dl id="compress/lzw"><dt><a href="/pkg/compress/lzw/">compress/lzw</a></dt>
332332
<dd>
333333
<p><!-- CL 273667 -->
334-
The new
335-
<a href="/pkg/compress/lzw/#Reader.Reset"><code>Reader.Reset</code></a>
336-
and
337-
<a href="/pkg/compress/lzw/#Writer.Reset"><code>Writer.Reset</code></a>
338-
methods allow reuse of a <code>Reader</code> or <code>Writer</code>.
334+
The <a href="/pkg/compress/lzw/#NewReader"><code>NewReader</code></a>
335+
function is guaranteed to return a value of the new
336+
type <a href="/pkg/compress/lzw/#Reader"><code>Reader</code></a>,
337+
and similarly <a href="/pkg/compress/lzw/#NewWriter"><code>NewWriter</code></a>
338+
is guaranteed to return a value of the new
339+
type <a href="/pkg/compress/lzw/#Writer"><code>Writer</code></a>.
340+
These new types both implement a <code>Reset</code> method
341+
(<a href="/pkg/compress/lzw/#Reader.Reset"><code>Reader.Reset</code></a>,
342+
<a href="/pkg/compress/lzw/#Writer.Reset"><code>Writer.Reset</code></a>)
343+
that allows reuse of the <code>Reader</code> or <code>Writer</code>.
339344
</p>
340345
</dd>
341346
</dl><!-- compress/lzw -->

0 commit comments

Comments
 (0)