diff --git a/CHANGELOG.md b/CHANGELOG.md index 4900e816..761b19e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ HTTP * Fix Body requirements doc * Fix illegal HTTP characters accepted as hex zero +* Fix Writer return value documentation WebSocket diff --git a/doc/types/Writer.qbk b/doc/types/Writer.qbk index 3015b238..90d4e6e3 100644 --- a/doc/types/Writer.qbk +++ b/doc/types/Writer.qbk @@ -167,7 +167,8 @@ public: the writer must guarantee that the buffers remain valid until the next member function is invoked, which may be the destructor. - @return `true` if there is data, `false` when done, + @return `true` if there is no more data to send, + `false` when there may be more data, boost::indeterminate to suspend. @note Undefined behavior if the callee takes ownership