From cee8c6625bd7a09db88daf5e9767cced66fb5c15 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Fri, 26 Apr 2019 20:30:51 +0200
Subject: Add upgrade/ws tuples to gun:await/2,3,4

---
 doc/src/manual/gun.await.asciidoc | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'doc/src/manual/gun.await.asciidoc')

diff --git a/doc/src/manual/gun.await.asciidoc b/doc/src/manual/gun.await.asciidoc
index 09c244b..0af6cee 100644
--- a/doc/src/manual/gun.await.asciidoc
+++ b/doc/src/manual/gun.await.asciidoc
@@ -69,6 +69,8 @@ Result :: {inform, Status, Headers}
         | {data, IsFin, Data}
         | {trailers, Trailers}
         | {push, NewStreamRef, Method, URI, Headers}
+        | {upgrade, Protocols, Headers}
+        | {ws, Frame}
         | {error, Reason}
 
 Reason :: {stream_error | connection_error | down, any()}
@@ -79,14 +81,18 @@ Because the messages and returned tuples are equivalent,
 please refer to the manual pages for each message for
 further information:
 
-* link:man:gun_push(3)[gun_push(3)] - Server-initiated push
 * link:man:gun_inform(3)[gun_inform(3)] - Informational response
 * link:man:gun_response(3)[gun_response(3)] - Response
 * link:man:gun_data(3)[gun_data(3)] - Response body
 * link:man:gun_trailers(3)[gun_trailers(3)] - Response trailers
+* link:man:gun_push(3)[gun_push(3)] - Server-initiated push
+* link:man:gun_upgrade(3)[gun_upgrade(3)] - Successful protocol upgrade
+* link:man:gun_ws(3)[gun_ws(3)] - Websocket frame
 
 == Changelog
 
+* *2.0*: `upgrade` and `ws` tuples can now be returned.
+* *2.0*: The error tuple type now includes the type of error.
 * *1.0*: Function introduced.
 
 == Examples
-- 
cgit v1.2.3

