From e4a78aaeb110a3eda5269b618230b8bcb18fbcc2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Mon, 8 Jan 2024 15:13:18 +0100
Subject: Document body reading in auto mode

It is now tested both via cowboy_req:read_body and
via cowboy_req:cast.

Removes a bad example from the guide of body reading
with period of infinity, which does not work.
---
 doc/src/manual/cowboy_req.asciidoc | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'doc/src/manual/cowboy_req.asciidoc')

diff --git a/doc/src/manual/cowboy_req.asciidoc b/doc/src/manual/cowboy_req.asciidoc
index 0a1ca1b..0367836 100644
--- a/doc/src/manual/cowboy_req.asciidoc
+++ b/doc/src/manual/cowboy_req.asciidoc
@@ -120,8 +120,8 @@ request's URI.
 [source,erlang]
 ----
 read_body_opts() :: #{
-    length  => non_neg_integer(),
-    period  => non_neg_integer(),
+    length  => non_neg_integer() | auto,
+    period  => non_neg_integer() | infinity,
     timeout => timeout()
 }
 ----
@@ -130,6 +130,10 @@ Body reading options.
 
 The defaults are function-specific.
 
+Auto mode can be enabled by setting `length` to `auto`
+and `period` to `infinity`. The period cannot be set
+to `infinity` when auto mode isn't used.
+
 === req()
 
 [source,erlang]
-- 
cgit v1.2.3

