New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document return value of start-http-server #56

Closed
kenrestivo opened this Issue Feb 24, 2012 · 1 comment

Comments

Projects
None yet
2 participants
@kenrestivo

kenrestivo commented Feb 24, 2012

    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

@ztellman ztellman closed this in ad42f96 Mar 3, 2012

@ztellman

This comment has been minimized.

Show comment
Hide comment
@ztellman

ztellman Mar 3, 2012

Owner

Thanks for the report. By the way, I swear the fact that potemkin is an acquired taste doesn't reflect on the quality of the libraries that use it :)

Owner

ztellman commented Mar 3, 2012

Thanks for the report. By the way, I swear the fact that potemkin is an acquired taste doesn't reflect on the quality of the libraries that use it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment