Note the :websocket? key in the api-doc for as-channel

immutant · Jul 20, 2015 · c0ab351 · c0ab351
1 parent 072e80d
commit c0ab351
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/web/src/immutant/web/async.clj b/web/src/immutant/web/async.clj
@@ -248,10 +248,10 @@
   "Converts the current ring `request` in to an asynchronous channel.
 
   The type of channel created depends on the request - if the request
-  is a Websocket upgrade request, a Websocket channel will be created.
-  Otherwise, an HTTP stream channel is created. You interact with both
-  channel types using the other functions in this namespace, and
-  through the given `callbacks`.
+  is a Websocket upgrade request (the :websocket? key is true), a
+  Websocket channel will be created. Otherwise, an HTTP stream channel
+  is created. You interact with both channel types using the other
+  functions in this namespace, and through the given `callbacks`.
 
   The callbacks common to both channel types are: