Skip to content

Commit cedc8d7

Browse files
YohDeadfallRon Petrusha
authored andcommitted
Fixed return types of channel reader/writer methods (dotnet#3138)
1 parent 3e8eb13 commit cedc8d7

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

xml/System.Threading.Channels/ChannelReader`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,8 @@ Each <xref:System.Collections.Generic.IAsyncEnumerator%601.MoveNextAsync> call t
165165
</Parameters>
166166
<Docs>
167167
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the wait operation.</param>
168-
<summary>Returns a <see cref="T:System.Threading.Tasks.Task`1" /> that will complete when data is available to read.</summary>
169-
<returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that will complete with a <see langword="true" /> result when data is available to read
168+
<summary>Returns a <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete when data is available to read.</summary>
169+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete with a <see langword="true" /> result when data is available to read
170170
or with a <see langword="false" /> result when no further data will ever be available to be read.</returns>
171171
<remarks>To be added.</remarks>
172172
</Docs>

xml/System.Threading.Channels/ChannelWriter`1.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@
140140
</Parameters>
141141
<Docs>
142142
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the wait operation.</param>
143-
<summary>Returns a <see cref="T:System.Threading.Tasks.Task`1" /> that will complete when space is available to write an item.</summary>
144-
<returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that will complete with a <see langword="true" /> result when space is available to write an item
143+
<summary>Returns a <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete when space is available to write an item.</summary>
144+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete with a <see langword="true" /> result when space is available to write an item
145145
or with a <see langword="false" /> result when no further writing will be permitted.</returns>
146146
<remarks>To be added.</remarks>
147147
</Docs>
@@ -168,7 +168,7 @@
168168
<param name="item">The value to write to the channel.</param>
169169
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the write operation.</param>
170170
<summary>Asynchronously writes an item to the channel.</summary>
171-
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous write operation.</returns>
171+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that represents the asynchronous write operation.</returns>
172172
<remarks>To be added.</remarks>
173173
</Docs>
174174
</Member>

0 commit comments

Comments
 (0)