Add CHANGELOG and a minor doc warning

jaspervdj · Dec 29, 2023 · ae2aa5e · ae2aa5e
1 parent cc3dd8b
commit ae2aa5e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,9 +1,17 @@
 # CHANGELOG
 
 - 0.13.0.0 (xxx)
+    * BREAKING: Remove `serverRequirePong` option in favor of the new implementation.
+    * BREAKING: Client: Rejecting request raises `RequestRejected RequestHead ResponseHead`
+    * Timeout initial socket connection after 30s.
+    * If the socket is closed unexpectedly, raise ConnectionClosed.
+    * Added a way to manually send a Pong message.
+    * `runServer` now cleans up threads correctly.
+    * Remove redundant bytestring-builder dependency.
     * Introduce `Network.WebSockets.Connection.PingPong` to
       handle ping pong for any Connection, be it Client or Server.
-    * Remove `serverRequirePong` option in favor of the new implementation.
+    * Bump `text `dependency upper bound to 2.2
+    * Bump `random `dependency lower bound to 1.0.1
 
 - 0.12.7.3 (2021-10-26)
     * Bump `attoparsec` dependency upper bound to 0.15

diff --git a/src/Network/WebSockets/Connection.hs b/src/Network/WebSockets/Connection.hs
@@ -241,6 +241,7 @@ rejectRequestWith pc reject = sendResponse pc $ Response
 
 
 --------------------------------------------------------------------------------
+-- | Requires calling 'pendingStream' and 'Stream.close'.
 rejectRequest
     :: PendingConnection  -- ^ Connection to reject
     -> B.ByteString       -- ^ Rejection response body