You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix misleading wording in PipeReader and PipeWriter's AsStream documentation. (#4156)
* Fix wording in PipeReader's AsStream docs
The old wording gets it exactly wrong - the PipeReader doesn't wrap the Stream, the Stream wraps the PipeReader.
Co-Authored-By: Stephen Halter <[email protected]>
Copy file name to clipboardExpand all lines: xml/System.IO.Pipelines/PipeReader.xml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -166,8 +166,8 @@ The examined data communicates to the pipeline when it should signal more data i
166
166
</Parameters>
167
167
<Docs>
168
168
<paramname="leaveOpen">An optional flag that indicates whether disposing the returned <seecref="T:System.IO.Stream" /> leaves <seecref="T:System.IO.Pipelines.PipeReader" /> open (<seelangword="true" />) or completes <seecref="T:System.IO.Pipelines.PipeReader" /> (<seelangword="false" />).</param>
169
-
<summary>Returns the underlying <seecref="T:System.IO.Stream" /> wrapped by the <seecref="T:System.IO.Pipelines.PipeReader" />.</summary>
170
-
<returns>The underlying stream.</returns>
169
+
<summary>Returns a <seecref="T:System.IO.Stream" /> representation of the <seecref="T:System.IO.Pipelines.PipeReader" />.</summary>
170
+
<returns>A stream that represents the <seecref="T:System.IO.Pipelines.PipeReader" />.</returns>
Copy file name to clipboardExpand all lines: xml/System.IO.Pipelines/PipeWriter.xml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -100,8 +100,8 @@
100
100
</Parameters>
101
101
<Docs>
102
102
<paramname="leaveOpen">An optional flag that indicates whether disposing the returned <seecref="T:System.IO.Stream" /> leaves <seecref="T:System.IO.Pipelines.PipeReader" /> open (<seelangword="true" />) or completes <seecref="T:System.IO.Pipelines.PipeReader" /> (<seelangword="false" />).</param>
103
-
<summary>Returns the underlying <seecref="T:System.IO.Stream" /> wrapped by the <seecref="T:System.IO.Pipelines.PipeWriter" />.</summary>
104
-
<returns>The underlying stream.</returns>
103
+
<summary>Returns a <seecref="T:System.IO.Stream" /> representation of the <seecref="T:System.IO.Pipelines.PipeWriter" />.</summary>
104
+
<returns>A stream that represents the <seecref="T:System.IO.Pipelines.PipeWriter" />.</returns>
0 commit comments