From ab72796fdcc30a1227cbdd9069bd36aff14ebcfc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Sat, 5 Jan 2019 17:50:30 +0100
Subject: Clarify option errors in the manual for gun:open/open_unix

Also fix an http into http2 for one option.
---
 doc/src/manual/gun.open_unix.asciidoc | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

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

diff --git a/doc/src/manual/gun.open_unix.asciidoc b/doc/src/manual/gun.open_unix.asciidoc
index 225ecc8..4ea8d2b 100644
--- a/doc/src/manual/gun.open_unix.asciidoc
+++ b/doc/src/manual/gun.open_unix.asciidoc
@@ -8,10 +8,12 @@ gun:open_unix - Open a connection to the given Unix domain socket
 
 [source,erlang]
 ----
-open_unix(SocketPath, Opts) -> {ok, pid()} | {error, any()}
+open_unix(SocketPath, Opts) -> {ok, pid()} | {error, Reason}
 
 SocketPath :: string()
 Opts       :: gun:opts()
+Reason     :: {options, OptName} | {options, {http | http2, OptName}} | any()
+OptName    :: atom()
 ----
 
 Open a connection to the given Unix domain socket.
-- 
cgit v1.2.3

