Skip to content

Commit c955cc6

Browse files
stephentoubRon Petrusha
andcommitted
Augment description of ChannelReader.WaitToReadAsync (#3324)
* Augment description of ChannelReader.WaitToReadAsync * Apply suggestions from code review Co-Authored-By: Ron Petrusha <[email protected]>
1 parent c455b85 commit c955cc6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,9 @@ Each <xref:System.Collections.Generic.IAsyncEnumerator%601.MoveNextAsync> call t
166166
<Docs>
167167
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the wait operation.</param>
168168
<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
170-
or with a <see langword="false" /> result when no further data will ever be available to be read.</returns>
169+
<returns><para>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete with a <see langword="true" /> result when data is available to read
170+
or with a <see langword="false" /> result when no further data will ever be available to be read due to the channel completing successfully.</para>
171+
<para>If the channel completes with an exception, the task will also complete with an exception.</para></returns>
171172
<remarks>To be added.</remarks>
172173
</Docs>
173174
</Member>

0 commit comments

Comments
 (0)