From 3ec0cd8b8d3d049ddd2506d7227b4e9647a215e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 8 Feb 2020 15:08:32 +0100 Subject: Clarify modifying/adding to the Req object --- doc/src/guide/req.asciidoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/src/guide/req.asciidoc b/doc/src/guide/req.asciidoc index 9d04ce0..754e470 100644 --- a/doc/src/guide/req.asciidoc +++ b/doc/src/guide/req.asciidoc @@ -48,10 +48,12 @@ Any other field is internal and should not be accessed. They may change in future releases, including maintenance releases, without notice. -Modifying the Req object, while allowed, is not recommended -unless strictly necessary. If adding new fields, make sure -to namespace the field names so that no conflict can occur -with future Cowboy updates or third party projects. +Modifying the Req object is allowed, but extra caution +must be used when modifying existing fields. You can +add as many new fields as necessary, however. Just make +sure to namespace the field names so that no conflict +can occur with future Cowboy updates or with third party +projects. === Introduction to the cowboy_req interface -- cgit v1.2.3