ztellman/aleph — Issue #56: Document return value of start-http-server
Author: kenrestivo
Created: 2012-02-24 23:51:18+00:00
State: open

```diff
update docstring to show the return value of start-http-server

Modified src/aleph/http/server.clj
diff --git a/src/aleph/http/server.clj b/src/aleph/http/server.clj
index e6d68a3..7f77e59 100644
--- a/src/aleph/http/server.clj
+++ b/src/aleph/http/server.clj
@@ -119,8 +119,9 @@
pipeline))

(defn start-http-server
- "Starts an HTTP server on the specified :port. To support WebSockets, set :websocket to
- true.
+ "Starts an HTTP server on the specified :port.
+ Returns a function that stops the server.
+ To support WebSockets, set :websocket to true.

'handler' should be a function that takes two parameters, a channel and a request hash.
The request is a hash that conforms to the Ring standard, with :websocket set to true

```