dotnet / dotnet/dotnet-api-docs
Summary can be easily misunderstood
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
My colleague and me both understood the summary "Signals to the IDataflowBlock that it should not accept nor produce any more messages" as "Items in the input queue of a TransformBlock MIGHT be processed but will definitely NOT be delivered to linked target blocks anymore after Complete() was called." However, testing revealed that all items that are in the InputQueue at the moment where Complete() is called WILL be processed and WILL also be delivered to linked target blocks. I think the summary should really clarify this fact because in Visual Studio we can only see the summary when hovering over the API.
---
#### Document Details
⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*
* ID: bf435904-0c4a-9099-529a-119dcea1862f
* Version Independent ID: 6664efd0-c249-718c-6b6c-33750ae9873d
* Content: [IDataflowBlock.Complete Method (System.Threading.Tasks.Dataflow)](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.dataflow.idataflowblock.complete?view=netcore-2.1)
* Content Source: [xml/System.Threading.Tasks.Dataflow/IDataflowBlock.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Threading.Tasks.Dataflow/IDataflowBlock.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**
Contributor guide
Assessment
This issue has not been assessed yet.