From 352206dee80905b10fa9af97f065ce7bee928d87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Fri, 26 Apr 2019 15:59:58 +0200
Subject: Add specs to await functions, document error type better

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

(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 21de953..09c244b 100644
--- a/doc/src/manual/gun.await.asciidoc
+++ b/doc/src/manual/gun.await.asciidoc
@@ -65,13 +65,14 @@ may also be returned when a timeout or an error occur.
 [source,erlang]
 ----
 Result :: {inform, Status, Headers}
-          {response, IsFin, Status, Headers}
-          {data, IsFin, Data}
-          {trailers, Trailers}
-          {push, NewStreamRef, Method, URI, Headers}
-          {error, Reason}
-
-Reason :: timeout | any()
+        | {response, IsFin, Status, Headers}
+        | {data, IsFin, Data}
+        | {trailers, Trailers}
+        | {push, NewStreamRef, Method, URI, Headers}
+        | {error, Reason}
+
+Reason :: {stream_error | connection_error | down, any()}
+        | timeout
 ----
 
 Because the messages and returned tuples are equivalent,
-- 
cgit v1.2.3