Skip to content

Commit be5ec0c

Browse files
committed
docs: Fix params list markup
This also fixes the following build warning: .../ws4py/server/cherrypyserver.py:docstring of ws4py.server.cherrypyserver.WebSocketPlugin.broadcast:6: WARNING: Definition list ends without a blank line; unexpected unindent.
1 parent 5dc605d commit be5ec0c

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

ws4py/server/cherrypyserver.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,8 +298,8 @@ def handle(self, ws_handler, peer_addr):
298298
"""
299299
Tracks the provided handler.
300300
301-
@param ws_handler: websocket handler instance
302-
@param peer_addr: remote peer address for tracing purpose
301+
:param ws_handler: websocket handler instance
302+
:param peer_addr: remote peer address for tracing purpose
303303
"""
304304
cherrypy.log("Managing WebSocket connection from %s:%d" % (peer_addr[0], peer_addr[1]))
305305
th = threading.Thread(target=ws_handler.run, name="WebSocket client at %s:%d" % (peer_addr[0], peer_addr[1]))
@@ -340,9 +340,9 @@ def broadcast(self, message, binary=False):
340340
Broadcasts a message to all connected clients known to
341341
the server.
342342
343-
@param message: a message suitable to pass to the send() method
343+
:param message: a message suitable to pass to the send() method
344344
of the connected handler.
345-
@param binary: whether or not the message is a binary one
345+
:param binary: whether or not the message is a binary one
346346
"""
347347
for ws_handler in self.pool:
348348
try:

0 commit comments

Comments
 (0)