A Couple of Documentation Improvements (#4285)

aio-libs · Oct 16, 2020 · a204341 · a204341
1 parent 30d1b46
commit a204341
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CHANGES/4285.doc b/CHANGES/4285.doc
@@ -0,0 +1 @@
+Improve some code examples in the documentation involving websockets and starting a simple HTTP site with an AppRunner.
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -138,8 +138,8 @@ peers. ::
 
         try:
             async for msg in channel.iter():
-                answer = process message(msg)
-                ws.send_str(answer)
+                answer = process_the_message(msg)  # your function here
+                await ws.send_str(answer)
         finally:
             await redis.unsubscribe('channel:1')
 

diff --git a/docs/web_advanced.rst b/docs/web_advanced.rst
@@ -770,6 +770,9 @@ The simple startup code for serving HTTP site on ``'localhost'``, port
     site = web.TCPSite(runner, 'localhost', 8080)
     await site.start()
 
+    while True:
+        await asyncio.sleep(3600)  # sleep forever
+
 To stop serving call :meth:`AppRunner.cleanup`::
 
     await runner.cleanup()