From 083651b5543504d1e9d5e93cbeb005e733671ba5 Mon Sep 17 00:00:00 2001 From: Michael Deutsch Date: Mon, 11 Sep 2023 18:21:17 +0300 Subject: [PATCH 1/3] Update ChannelWriter`1.xml Addresses #9250 --- xml/System.Threading.Channels/ChannelWriter`1.xml | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/xml/System.Threading.Channels/ChannelWriter`1.xml b/xml/System.Threading.Channels/ChannelWriter`1.xml index 5b1b9c9c3cc..4f56b84e48d 100644 --- a/xml/System.Threading.Channels/ChannelWriter`1.xml +++ b/xml/System.Threading.Channels/ChannelWriter`1.xml @@ -159,8 +159,7 @@ The item to write. Attempts to write the specified item to the channel. - - if the item was written; otherwise, . + if the item was written; otherwise, . To be added. @@ -196,9 +195,14 @@ A used to cancel the wait operation. Returns a that will complete when space is available to write an item. - A that will complete with a result when space is available to write an item - or with a result when no further writing will be permitted. - To be added. + + A that will complete with a result when space is available to write an item + or with a result when no further writing will be permitted. + If the channel was completed with an exception, this task will also complete with an exception. + + The channel has already been marked as complete, including an inner exception. + If the channel was already closed, this method will not return . Whether it returns or throws an exception + depends on whether an exception was provided in the call to complete it or not. @@ -236,6 +240,7 @@ A used to cancel the write operation. Asynchronously writes an item to the channel. A that represents the asynchronous write operation. + The channel has already been marked as complete. To be added. From a46ed7b377cb593cfa0be47f63e49c1554f1be86 Mon Sep 17 00:00:00 2001 From: Michael Deutsch Date: Tue, 12 Sep 2023 10:43:15 +0300 Subject: [PATCH 2/3] Update ChannelWriter`1.xml - fix typo Add missing slash in xml tag --- xml/System.Threading.Channels/ChannelWriter`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Threading.Channels/ChannelWriter`1.xml b/xml/System.Threading.Channels/ChannelWriter`1.xml index 4f56b84e48d..c967dfe96b0 100644 --- a/xml/System.Threading.Channels/ChannelWriter`1.xml +++ b/xml/System.Threading.Channels/ChannelWriter`1.xml @@ -201,7 +201,7 @@ If the channel was completed with an exception, this task will also complete with an exception. The channel has already been marked as complete, including an inner exception. - If the channel was already closed, this method will not return . Whether it returns or throws an exception + If the channel was already closed, this method will not return . Whether it returns or throws an exception depends on whether an exception was provided in the call to complete it or not. From cffed005118157aca0b0c2c9741a5cbfb32c6866 Mon Sep 17 00:00:00 2001 From: Michael Deutsch Date: Thu, 28 Sep 2023 15:07:05 +0300 Subject: [PATCH 3/3] Apply suggestions from CR --- xml/System.Threading.Channels/ChannelWriter`1.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/xml/System.Threading.Channels/ChannelWriter`1.xml b/xml/System.Threading.Channels/ChannelWriter`1.xml index c967dfe96b0..1f8f9ccb287 100644 --- a/xml/System.Threading.Channels/ChannelWriter`1.xml +++ b/xml/System.Threading.Channels/ChannelWriter`1.xml @@ -159,7 +159,8 @@ The item to write. Attempts to write the specified item to the channel. - if the item was written; otherwise, . + + if the item was written; otherwise, . To be added. @@ -201,7 +202,7 @@ If the channel was completed with an exception, this task will also complete with an exception. The channel has already been marked as complete, including an inner exception. - If the channel was already closed, this method will not return . Whether it returns or throws an exception + If the channel was already closed, this method does not return . Whether it returns or throws an exception depends on whether an exception was provided in the call to complete it or not.