From 34aa233aa7ae222aded1325a165a3672401d5e34 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Sun, 13 Dec 2009 03:07:19 -0800
Subject: [PATCH] web_socket: RDoc fixups

---
 lib/sunshowers/web_socket.rb | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/lib/sunshowers/web_socket.rb b/lib/sunshowers/web_socket.rb
index 750cfeb..c9ceb8d 100644
--- a/lib/sunshowers/web_socket.rb
+++ b/lib/sunshowers/web_socket.rb
@@ -58,7 +58,7 @@ module Sunshowers
       protocol
     end
 
-    # returns the ws://... or ws:/// URL
+    # returns the ws://... or wss://... URL
     def ws_location
       s = ws_scheme
       rv = "#{s}://#{host}"
@@ -79,7 +79,10 @@ module Sunshowers
     end
 
     # Terminates the Web Sockets request/response cycle and
-    # Rack application dispatch.
+    # current Rack application dispatch.  Other middlewares
+    # may rescue Sunshowers::WebSocket::Quit to avoid this.
+    # This does NOT attempt to close the socket, that is still
+    # the responsibility of the web server.
     def ws_quit!
       raise Quit, "done processing WebSocket request"
     end
-- 
2.11.4.GIT