vs-threading icon indicating copy to clipboard operation
vs-threading copied to clipboard

Documentation for AsyncQueue.IsCompleted is incorrect; should indicate it depends on whether the queue is emptp

Open dpugh opened this issue 1 year ago • 0 comments

Bug description

The documentation for IsCompleted is "Gets a value indicating whether the queue has completed." which implies that it is determined by whether AsyncQueue.Complete() has been called.

The actual implementation seems to be:

    public bool IsCompleted
    {
        get
        {
            lock (SyncRoot)
            {
                return completeSignaled && IsEmpty;
            }
        }
    }

Which returns true if and only if the queue is completed and it is empty.

Changing the implementation at this point would be bad, but the documentation should be changed to something like: "Gets a value indicating whether the queue has completed and empty."

dpugh avatar Apr 29 '24 19:04 dpugh