aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.await_body.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-04-26 15:59:58 +0200
committerLoïc Hoguin <[email protected]>2019-04-26 15:59:58 +0200
commit352206dee80905b10fa9af97f065ce7bee928d87 (patch)
tree5eb48b3c5689c61cb26329317475ee3b67370752 /doc/src/manual/gun.await_body.asciidoc
parentf422624ce4527ce5b07bad63c5fda50e13ff4994 (diff)
downloadgun-352206dee80905b10fa9af97f065ce7bee928d87.tar.gz
gun-352206dee80905b10fa9af97f065ce7bee928d87.tar.bz2
gun-352206dee80905b10fa9af97f065ce7bee928d87.zip
Add specs to await functions, document error type better
Diffstat (limited to 'doc/src/manual/gun.await_body.asciidoc')
-rw-r--r--doc/src/manual/gun.await_body.asciidoc3
1 files changed, 2 insertions, 1 deletions
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.