Skip to content

Commit 3a4c6c4

Browse files
Benjamin Hodgsonhalter73
andauthored
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]>
1 parent 1bc5416 commit 3a4c6c4

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

xml/System.IO.Pipelines/PipeReader.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ The examined data communicates to the pipeline when it should signal more data i
166166
</Parameters>
167167
<Docs>
168168
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
169-
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
170-
<returns>The underlying stream.</returns>
169+
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
170+
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
171171
<remarks>To be added.</remarks>
172172
</Docs>
173173
</Member>

xml/System.IO.Pipelines/PipeWriter.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@
100100
</Parameters>
101101
<Docs>
102102
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
103-
<summary> Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
104-
<returns>The underlying stream.</returns>
103+
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
104+
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeWriter" />.</returns>
105105
<remarks>To be added.</remarks>
106106
</Docs>
107107
</Member>

0 commit comments

Comments
 (0)