From 352206dee80905b10fa9af97f065ce7bee928d87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= 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 ++++++++------- doc/src/manual/gun.await_body.asciidoc | 3 ++- doc/src/manual/gun.await_up.asciidoc | 2 +- 3 files changed, 11 insertions(+), 9 deletions(-) (limited to 'doc') 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, diff --git a/doc/src/manual/gun.await_body.asciidoc b/doc/src/manual/gun.await_body.asciidoc index 9ac26d9..0505112 100644 --- a/doc/src/manual/gun.await_body.asciidoc +++ b/doc/src/manual/gun.await_body.asciidoc @@ -26,7 +26,8 @@ MonitorRef :: reference() Timeout :: timeout() Body :: binary() Trailers :: [{binary(), binary()}] -Reason :: timeout | any() +Reason :: {stream_error | connection_error | down, any()} + | timeout ---- Wait for the complete response body. diff --git a/doc/src/manual/gun.await_up.asciidoc b/doc/src/manual/gun.await_up.asciidoc index 3937665..2639943 100644 --- a/doc/src/manual/gun.await_up.asciidoc +++ b/doc/src/manual/gun.await_up.asciidoc @@ -24,7 +24,7 @@ ConnPid :: pid() MonitorRef :: reference() Timeout :: timeout() Protocol :: http | http2 -Reason :: timeout | any() +Reason :: {down, any()} | timeout ---- Wait for the connection to be up. -- cgit v1.2.3