From 630bd475e6aa4b9fdde01272236d08305034cb48 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Mon, 31 Dec 2018 17:08:59 +0100
Subject: Separate request/4,5,6 into headers/4,5 and request/5,6

This cleaner separation gets rid of the implicit body check
that was causing issues for many users. Now the body is
either given explicitly or it is expected via future
gun:data/3 calls.
---
 doc/src/manual/gun.put.asciidoc | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

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

diff --git a/doc/src/manual/gun.put.asciidoc b/doc/src/manual/gun.put.asciidoc
index 4f0cb39..a60849b 100644
--- a/doc/src/manual/gun.put.asciidoc
+++ b/doc/src/manual/gun.put.asciidoc
@@ -9,6 +9,9 @@ gun:put - Create or replace a resource
 [source,erlang]
 ----
 put(ConnPid, Path, Headers)
+    -> put(ConnPid, Path, Headers, #{})
+
+put(ConnPid, Path, Headers, ReqOpts)
     -> StreamRef
 
 put(ConnPid, Path, Headers, Body)
@@ -30,10 +33,8 @@ Create or replace a resource.
 The behavior of this function varies depending on whether
 a body is provided.
 
-The function `put/3` expects either a content-length
-or content-type header to indicate that a body will be
-sent afterwards. The body can then be sent using
-link:man:gun:data(3)[gun:data(3)].
+The function `put/3,4` does not send a body. It must be
+sent separately using link:man:gun:data(3)[gun:data(3)].
 
 The function `put/4,5` sends the entire request, including
 the request body, immediately. It is therefore not possible
@@ -72,6 +73,9 @@ to this new stream.
 
 == Changelog
 
+* *2.0*: Implicit body detection has been removed. The body
+         must now be provided either directly (even if empty)
+         or using separate calls.
 * *1.0*: Function introduced.
 
 == Examples
-- 
cgit v1.2.3

