path: root/doc
diff options
authorLoïc Hoguin <[email protected]>2020-02-08 15:08:32 +0100
committerLoïc Hoguin <[email protected]>2020-02-08 15:32:46 +0100
commit3ec0cd8b8d3d049ddd2506d7227b4e9647a215e8 (patch)
tree559c348c5d759dacfcb6f783e07a5e0ee774564e /doc
parent8fc3da2fc31a04281b0ba8dc0cdc1e1650067da5 (diff)
Clarify modifying/adding to the Req object
Diffstat (limited to 'doc')
1 files changed, 6 insertions, 4 deletions
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
=== Introduction to the cowboy_req interface