From 6f56d1a4103bf8521e5824ae00411a7889342947 Mon Sep 17 00:00:00 2001 From: Ben Darnell Date: Wed, 6 Nov 2013 14:57:31 -0500 Subject: [PATCH] Document the fact that WebSocketClientConnection should not be used directly. Closes #929. --- tornado/websocket.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tornado/websocket.py b/tornado/websocket.py index 3a83994c0..8c2f5a647 100644 --- 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 -- 2.47.3