From 1551cb05631ec87de28ec5736c880531aa7d905f Mon Sep 17 00:00:00 2001
From: Sergio <ftxrc@users.noreply.github.com>
Date: Thu, 22 Jun 2017 20:53:00 -0400
Subject: [PATCH] Improve docs consistency on query strings (#681)

Change to room_name parameter and erase references to query strings throughout the documentation tutorial.
---
 docs/getting-started.rst | 24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)

diff --git a/docs/getting-started.rst b/docs/getting-started.rst
index 3424948..b42eafc 100644
--- a/docs/getting-started.rst
+++ b/docs/getting-started.rst
@@ -364,7 +364,7 @@ Persisting Data
 Echoing messages is a nice simple example, but it's ignoring the real
 need for a system like this - persistent state for connections.
 Let's consider a basic chat site where a user requests a chat room upon initial
-connection, as part of the query string (e.g. ``wss://host/websocket?room=abc``).
+connection, as part of the URL path (e.g. ``wss://host/rooms/room-name``).
 
 The ``reply_channel`` attribute you've seen before is our unique pointer to the
 open WebSocket - because it varies between different clients, it's how we can
@@ -390,26 +390,24 @@ name in the path of your WebSocket request (we'll ignore auth for now - that's n
 
     # Connected to websocket.connect
     @channel_session
-    def ws_connect(message):
+    def ws_connect(message, room_name):
         # Accept connection
         message.reply_channel.send({"accept": True})
-        # Work out room name from path (ignore slashes)
-        room = message.content['path'].strip("/")
         # Save room in session and add us to the group
-        message.channel_session['room'] = room
+        message.channel_session['room_name'] = room_name
         Group("chat-%s" % room).add(message.reply_channel)
 
     # Connected to websocket.receive
     @channel_session
-    def ws_message(message):
-        Group("chat-%s" % message.channel_session['room']).send({
+    def ws_message(message, room_name):
+        Group("chat-%s" % message.channel_session['room_name']).send({
             "text": message['text'],
         })
 
     # Connected to websocket.disconnect
     @channel_session
-    def ws_disconnect(message):
-        Group("chat-%s" % message.channel_session['room']).discard(message.reply_channel)
+    def ws_disconnect(message, room_name):
+        Group("chat-%s" % room_name).discard(message.reply_channel)
 
 Update ``routing.py`` as well::
 
@@ -591,7 +589,7 @@ routing our chat from above::
     ]
 
     chat_routing = [
-        route("websocket.connect", chat_connect, path=r"^/(?P<room>[a-zA-Z0-9_]+)/$"),
+        route("websocket.connect", chat_connect, path=r"^/(?P<room_name>[a-zA-Z0-9_]+)/$"),
         route("websocket.disconnect", chat_disconnect),
     ]
 
@@ -616,13 +614,13 @@ consumer above to use a room based on URL rather than username::
 
     # Connected to websocket.connect
     @channel_session_user_from_http
-    def ws_add(message, room):
+    def ws_add(message, room_name):
         # Add them to the right group
-        Group("chat-%s" % room).add(message.reply_channel)
+        Group("chat-%s" % room_name).add(message.reply_channel)
         # Accept the connection request
         message.reply_channel.send({"accept": True})
 
-In the next section, we'll change to sending the ``room`` as a part of the
+In the next section, we'll change to sending the ``room_name`` as a part of the
 WebSocket message - which you might do if you had a multiplexing client -
 but you could use routing there as well.