Document the fact that WebSocketClientConnection should not be used directly.

Closes #929.

diff --git a/tornado/websocket.py b/tornado/websocket.py
index 3a83994c0d82b11e955d9469612d5672f6ffa679..8c2f5a647e8c45c40c3781038d2bda4d264b4fcf 100644 (file)
--- a/tornado/websocket.py
+++ b/tornado/websocket.py
@@ -768,7 +768,11 @@ class WebSocketProtocol13(WebSocketProtocol):
 
 
 class WebSocketClientConnection(simple_httpclient._HTTPConnection):
-    """WebSocket client connection."""
+    """WebSocket client connection.
+
+    This class should not be instantiated directly; use the
+    `websocket_connect` function instead.
+    """
     def __init__(self, io_loop, request):
         self.connect_future = TracebackFuture()
         self.read_future = None