aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.open.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/gun.open.asciidoc')
-rw-r--r--doc/src/manual/gun.open.asciidoc10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/src/manual/gun.open.asciidoc b/doc/src/manual/gun.open.asciidoc
index 2e6c8b9..79a9d54 100644
--- a/doc/src/manual/gun.open.asciidoc
+++ b/doc/src/manual/gun.open.asciidoc
@@ -9,11 +9,13 @@ gun:open - Open a connection to the given host and port
[source,erlang]
----
open(Host, Port) -> open(Host, Port, #{})
-open(Host, Port, Opts) -> {ok, pid()} | {error, any()}
+open(Host, Port, Opts) -> {ok, pid()} | {error, Reason}
-Host :: inet:hostname() | inet:ip_address()
-Port :: inet:port_number()
-Opts :: gun:opts()
+Host :: inet:hostname() | inet:ip_address()
+Port :: inet:port_number()
+Opts :: gun:opts()
+Reason :: {options, OptName} | {options, {http | http2, OptName}} | any()
+OptName :: atom()
----
Open a connection to the given host and port.