aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/ws_handlers.ezdoc
diff options
context:
space:
mode:
authorStefan Strigler <[email protected]>2014-10-08 16:49:18 +0200
committerStefan Strigler <[email protected]>2014-10-08 16:49:18 +0200
commit8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429 (patch)
tree8337c1aff021ee40dccdac0c52a741b6bcb17929 /doc/src/guide/ws_handlers.ezdoc
parentb87150c713fe16601b314451b2fe25b62bd820bb (diff)
downloadcowboy-8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429.tar.gz
cowboy-8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429.tar.bz2
cowboy-8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429.zip
change init/2 to return #state{} in documentation
Most examples returned 'Opts' as given by second argument to init. By using '#state{}' the examples make it more clear that this is what is being passed as 'State' to all subsequent callbacks (if any).
Diffstat (limited to 'doc/src/guide/ws_handlers.ezdoc')
-rw-r--r--doc/src/guide/ws_handlers.ezdoc4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/src/guide/ws_handlers.ezdoc b/doc/src/guide/ws_handlers.ezdoc
index cb30511..9f0fcbb 100644
--- a/doc/src/guide/ws_handlers.ezdoc
+++ b/doc/src/guide/ws_handlers.ezdoc
@@ -16,8 +16,8 @@ to all handlers. To establish a Websocket connection, this function
must return a `ws` tuple.
``` erlang
-init(Req, Opts) ->
- {cowboy_websocket, Req, Opts}.
+init(Req, _Opts) ->
+ {cowboy_websocket, Req, #state{}}.
```
Upon receiving this tuple, Cowboy will switch to the code