aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-04-26 14:32:56 +0200
committerLoïc Hoguin <[email protected]>2014-04-26 14:32:56 +0200
commit87cd5a220662eecaa5476da3c145f0617b73f734 (patch)
tree03dfa8871e2cfdcad4f9f3d0c730935cc0f0cf7c
parent980342f73c381413a09fbea94b43428e0f16d787 (diff)
downloadcowboy-87cd5a220662eecaa5476da3c145f0617b73f734.tar.gz
cowboy-87cd5a220662eecaa5476da3c145f0617b73f734.tar.bz2
cowboy-87cd5a220662eecaa5476da3c145f0617b73f734.zip
Change wording in the guide to remove ambiguity
-rw-r--r--guide/req.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/guide/req.md b/guide/req.md
index 2b59152..f93623a 100644
--- a/guide/req.md
+++ b/guide/req.md
@@ -62,8 +62,10 @@ or `{error, atom()}`. This includes the following functions:
also includes the `chunk/2` function which always returns
`ok`.
-The final group modifies the Req object, so it always return
-a new `Req`. It includes the following functions: `compact/1`,
+The final group modifies the Req object state without
+performing any immediate operations. As these functions
+can't fail, they always return a new `Req` directly.
+This includes the following functions: `compact/1`,
`delete_resp_header/2`, `set_meta/3`, `set_resp_body/2`,
`set_resp_body_fun/{2,3}`, `set_resp_cookie/4`, `set_resp_header/3`.