Skip to content

Clarify exceptions for ChannelWriter methods #9268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MichaelDeutschCoding wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarify exceptions for ChannelWriter methods #9268

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
083651b
Update ChannelWriter`1.xml
MichaelDeutschCoding Sep 11, 2023
a46ed7b
Update ChannelWriter`1.xml - fix typo
MichaelDeutschCoding Sep 12, 2023
cffed00
Apply suggestions from CR
MichaelDeutschCoding Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions xml/System.Threading.Channels/ChannelWriter`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,7 @@
<Docs>
<param name="item">The item to write.</param>
<summary>Attempts to write the specified item to the channel.</summary>
<returns>
<see langword="true" /> if the item was written; otherwise, <see langword="false" />.</returns>
<returns><see langword="true" /> if the item was written; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -196,9 +195,14 @@
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the wait operation.</param>
<summary>Returns a <see cref="T:System.Threading.Tasks.ValueTask`1" /> that will complete when space is available to write an item.</summary>
<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
or with a <see langword="false" /> result when no further writing will be permitted.</returns>
<remarks>To be added.</remarks>
<returns>
<para>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
or with a <see langword="false" /> result when no further writing will be permitted.</para>
<para>If the channel was completed with an exception, this task will also complete with an exception.</para>
</returns>
<exception cref="T:System.Threading.Channels.ChannelClosedException">The channel has already been marked as complete, including an inner exception.</exception>
<remarks>If the channel was already closed, this method will not return <see langword="true" />. Whether it returns <see langword="false" /> or throws an exception
depends on whether an exception was provided in the call to complete it or not.</remarks>
</Docs>
</Member>
<Member MemberName="WriteAsync">
Expand Down Expand Up @@ -236,6 +240,7 @@
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used to cancel the write operation.</param>
<summary>Asynchronously writes an item to the channel.</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that represents the asynchronous write operation.</returns>
<exception cref="T:System.Threading.Channels.ChannelClosedException">The channel has already been marked as complete.</exception>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down