From 3dac05157f75c84ed016230a32463f1bbc16cdcf Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Tue, 21 Mar 2017 07:59:22 -0700 Subject: [PATCH] add documentation for #433 --- flask_socketio/__init__.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/flask_socketio/__init__.py b/flask_socketio/__init__.py index 2418984a..9a35855c 100644 --- a/flask_socketio/__init__.py +++ b/flask_socketio/__init__.py @@ -707,6 +707,8 @@ def on_join(data): :param room: The name of the room to join. :param sid: The session id of the client. If not provided, the client is obtained from the request context. + :param namespace: The namespace for the room. If not provided, the + namespace is obtained from the request context. """ socketio = flask.current_app.extensions['socketio'] sid = sid or flask.request.sid @@ -730,6 +732,8 @@ def on_leave(data): :param room: The name of the room to leave. :param sid: The session id of the client. If not provided, the client is obtained from the request context. + :param namespace: The namespace for the room. If not provided, the + namespace is obtained from the request context. """ socketio = flask.current_app.extensions['socketio'] sid = sid or flask.request.sid @@ -744,6 +748,8 @@ def close_room(room, namespace=None): the room from the server. :param room: The name of the room to close. + :param namespace: The namespace for the room. If not provided, the + namespace is obtained from the request context. """ socketio = flask.current_app.extensions['socketio'] namespace = namespace or flask.request.namespace @@ -758,6 +764,8 @@ def rooms(sid=None, namespace=None): :param sid: The session id of the client. If not provided, the client is obtained from the request context. + :param namespace: The namespace for the room. If not provided, the + namespace is obtained from the request context. """ socketio = flask.current_app.extensions['socketio'] sid = sid or flask.request.sid