Improve documentation about gun:headers/4,5

9 files changed, 15 insertions, 8 deletions

diff --git a/doc/src/guide/http.asciidoc b/doc/src/guide/http.asciidoc
index fb0c7dc..382b245 100644
--- a/doc/src/guide/http.asciidoc
+++ b/doc/src/guide/http.asciidoc
@@ -218,16 +218,17 @@ StreamRef = gun:options(ConnPid, "*").
 
 ==== Requests with an arbitrary method
 
-The `gun:request/4,5,6` function can be used to send requests
-with a configurable method name. It is mostly useful when you
-need a method that Gun does not understand natively.
+The functions `gun:headers/4,5` or `gun:request/5,6` can be
+used to send requests with a configurable method name. It is
+mostly useful when you need a method that Gun does not
+understand natively.
 
 .Example of a TRACE request
 [source,erlang]
 ----
 gun:request(ConnPid, "TRACE", "/", [
     {<<"max-forwards">>, "30"}
-]).
+], <<>>).
 ----
 
 === Processing responses
diff --git a/doc/src/guide/protocols.asciidoc b/doc/src/guide/protocols.asciidoc
index 2c4fd10..d2529e3 100644
--- a/doc/src/guide/protocols.asciidoc
+++ b/doc/src/guide/protocols.asciidoc
@@ -11,9 +11,9 @@ sends a request, the server sends back a response.
 
 Gun provides convenience functions for performing GET, HEAD,
 OPTIONS, POST, PATCH, PUT, and DELETE requests. All these
-functions are aliases of `gun:request/4,5,6` for the respective
-methods. Gun also provides a `gun:data/4` function for streaming
-the request body.
+functions are aliases of `gun:headers/4,5` or `gun:request/5,6`
+for the respective methods. Gun also provides a `gun:data/4`
+function for streaming the request body.
 
 Gun will send a `gun_inform` message for every intermediate
 informational responses received. They will always be sent
diff --git a/doc/src/manual/gun.await.asciidoc b/doc/src/manual/gun.await.asciidoc
index b96d643..21de953 100644
--- a/doc/src/manual/gun.await.asciidoc
+++ b/doc/src/manual/gun.await.asciidoc
@@ -110,5 +110,6 @@ link:man:gun:patch(3)[gun:patch(3)],
 link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
+link:man:gun:headers(3)[gun:headers(3)],
 link:man:gun:request(3)[gun:request(3)],
 link:man:gun:await_body(3)[gun:await_body(3)]
diff --git a/doc/src/manual/gun.await_body.asciidoc b/doc/src/manual/gun.await_body.asciidoc
index ac6a8c4..9ac26d9 100644
--- a/doc/src/manual/gun.await_body.asciidoc
+++ b/doc/src/manual/gun.await_body.asciidoc
@@ -84,5 +84,6 @@ link:man:gun:patch(3)[gun:patch(3)],
 link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
+link:man:gun:headers(3)[gun:headers(3)],
 link:man:gun:request(3)[gun:request(3)],
 link:man:gun:await(3)[gun:await(3)]
diff --git a/doc/src/manual/gun.cancel.asciidoc b/doc/src/manual/gun.cancel.asciidoc
index fd86eba..7072c47 100644
--- a/doc/src/manual/gun.cancel.asciidoc
+++ b/doc/src/manual/gun.cancel.asciidoc
@@ -65,5 +65,6 @@ link:man:gun:patch(3)[gun:patch(3)],
 link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
+link:man:gun:headers(3)[gun:headers(3)],
 link:man:gun:request(3)[gun:request(3)],
 link:man:gun:stream_info(3)[gun:stream_info(3)]
diff --git a/doc/src/manual/gun.data.asciidoc b/doc/src/manual/gun.data.asciidoc
index 9c65d34..08387b7 100644
--- a/doc/src/manual/gun.data.asciidoc
+++ b/doc/src/manual/gun.data.asciidoc
@@ -72,4 +72,4 @@ link:man:gun(3)[gun(3)],
 link:man:gun:patch(3)[gun:patch(3)],
 link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
-link:man:gun:request(3)[gun:request(3)]
+link:man:gun:headers(3)[gun:headers(3)]
diff --git a/doc/src/manual/gun_data.asciidoc b/doc/src/manual/gun_data.asciidoc
index 0176707..06797a2 100644
--- a/doc/src/manual/gun_data.asciidoc
+++ b/doc/src/manual/gun_data.asciidoc
@@ -72,6 +72,7 @@ link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
 link:man:gun:options(3)[gun:options(3)],
+link:man:gun:headers(3)[gun:headers(3)],
 link:man:gun:request(3)[gun:request(3)],
 link:man:gun_response(3)[gun_response(3)],
 link:man:gun_trailers(3)[gun_trailers(3)]
diff --git a/doc/src/manual/gun_response.asciidoc b/doc/src/manual/gun_response.asciidoc
index cc55b44..b273fc3 100644
--- a/doc/src/manual/gun_response.asciidoc
+++ b/doc/src/manual/gun_response.asciidoc
@@ -70,6 +70,7 @@ link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
 link:man:gun:options(3)[gun:options(3)],
+link:man:gun:headers(3)[gun:headers(3)],
 link:man:gun:request(3)[gun:request(3)],
 link:man:gun_inform(3)[gun_inform(3)],
 link:man:gun_push(3)[gun_push(3)]
diff --git a/doc/src/manual/gun_trailers.asciidoc b/doc/src/manual/gun_trailers.asciidoc
index d1862fa..8921419 100644
--- a/doc/src/manual/gun_trailers.asciidoc
+++ b/doc/src/manual/gun_trailers.asciidoc
@@ -62,6 +62,7 @@ link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
 link:man:gun:options(3)[gun:options(3)],
+link:man:gun:headers(3)[gun:headers(3)],
 link:man:gun:request(3)[gun:request(3)],
 link:man:gun_response(3)[gun_response(3)],
 link:man:gun_data(3)[gun_data(3)]