umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00
Code Issues Wiki Activity

Clarify modifying/adding to the Req object

Browse source
This commit is contained in:
Loïc Hoguin 2020-02-08 15:08:32 +01:00
parent 8fc3da2fc3
commit 3ec0cd8b8d
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/src/guide/req.asciidoc
View file

@ -48,10 +48,12 @@ Any other field is internal and should not be accessed.
They may change in future releases, including maintenance They may change in future releases, including maintenance
releases, without notice. releases, without notice.
Modifying the Req object, while allowed, is not recommended Modifying the Req object is allowed, but extra caution
unless strictly necessary. If adding new fields, make sure must be used when modifying existing fields. You can
to namespace the field names so that no conflict can occur add as many new fields as necessary, however. Just make
with future Cowboy updates or third party projects. 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 === Introduction to the cowboy_req interface