From 1897a2a9fc6db3cd2104858d5ffa0f7c2c4824d4 Mon Sep 17 00:00:00 2001 From: Nat Goodspeed Date: Wed, 5 Aug 2015 07:51:10 -0400 Subject: [PATCH] Explain that is_closed() doesn't imply is_empty(). --- doc/channel.qbk | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/channel.qbk b/doc/channel.qbk index e1960a12..1df10bd5 100644 --- a/doc/channel.qbk +++ b/doc/channel.qbk @@ -110,7 +110,9 @@ channel operations return the state of the channel. [variablelist [[Returns:] [`true` if channel has been closed.]] [[Throws:] [Nothing.]] -[[Note:] [The channel is not closed by default.]] +[[Note:] [The channel is not closed by default. `is_closed()` returns `true` +when `close()` has been called, whether or not there are pending values in the +channel. The channel is not exhausted until `is_closed() && is_empty()`.]] ] ] [xchannel_is_closed unbounded_channel]