Misc docs updates

Author: Archmonger

CHANGELOG.md

@@ -50,7 +50,7 @@ Using the following categories, list your changes in this order:
 
 ### Changed
 
--   Simplified code for cascading deletion of UserData.
+-   Simplified code for cascading deletion of user data.
 
 ## [3.7.0] - 2024-01-30
 

docs/examples/python/configure-asgi-middleware.py

@@ -11,10 +11,6 @@
 application = ProtocolTypeRouter(
     {
         "http": django_asgi_app,
-        "websocket": AuthMiddlewareStack(
-            URLRouter(
-                [REACTPY_WEBSOCKET_ROUTE],
-            )
-        ),
+        "websocket": AuthMiddlewareStack(URLRouter([REACTPY_WEBSOCKET_ROUTE])),
     }
 )

docs/examples/python/use-channel-layer.py

@@ -3,26 +3,20 @@
 
 
 @component
-def my_sender_component():
-    sender = use_channel_layer("my-channel-name")
+def my_component():
+    async def receive_message(message):
+        set_message(message["text"])
 
-    async def submit_event(event):
+    async def send_message(event):
         if event["key"] == "Enter":
             await sender({"text": event["target"]["value"]})
 
-    return html.div(
-        "Message Sender: ",
-        html.input({"type": "text", "onKeyDown": submit_event}),
-    )
-
-
-@component
-def my_receiver_component():
     message, set_message = hooks.use_state("")
+    sender = use_channel_layer("my-channel-name", receiver=receive_message)
 
-    async def receive_event(message):
-        set_message(message["text"])
-
-    use_channel_layer("my-channel-name", receiver=receive_event)
-
-    return html.div(f"Message Receiver: {message}")
+    return html.div(
+        f"Received: {message}",
+        html.br(),
+        "Send: ",
+        html.input({"type": "text", "onKeyDown": send_message}),
+    )

docs/examples/python/user-passes-test-component-fallback.py

@@ -7,11 +7,11 @@ def my_component_fallback():
     return html.div("I am NOT logged in!")
 
 
-def auth_check(user):
+def is_authenticated(user):
     return user.is_authenticated
 
 
-@user_passes_test(auth_check, fallback=my_component_fallback)
+@user_passes_test(is_authenticated, fallback=my_component_fallback)
 @component
 def my_component():
     return html.div("I am logged in!")

docs/examples/python/user-passes-test-vdom-fallback.py

@@ -2,11 +2,11 @@
 from reactpy_django.decorators import user_passes_test
 
 
-def auth_check(user):
+def is_authenticated(user):
     return user.is_authenticated
 
 
-@user_passes_test(auth_check, fallback=html.div("I am NOT logged in!"))
+@user_passes_test(is_authenticated, fallback=html.div("I am NOT logged in!"))
 @component
 def my_component():
     return html.div("I am logged in!")

docs/examples/python/user-passes-test.py

@@ -2,11 +2,11 @@
 from reactpy_django.decorators import user_passes_test
 
 
-def auth_check(user):
+def is_authenticated(user):
     return user.is_authenticated
 
 
-@user_passes_test(auth_check)
+@user_passes_test(is_authenticated)
 @component
 def my_component():
     return html.div("I am logged in!")

docs/src/reference/hooks.md

@@ -536,15 +536,15 @@ This is useful when used in combination with [`#!python use_channel_layer`](#use
 
 ??? example "See Interface"
 
-        <font size="4">**Parameters**</font>
+    <font size="4">**Parameters**</font>
 
-        `#!python None`
+    `#!python None`
 
-        <font size="4">**Returns**</font>
+    <font size="4">**Returns**</font>
 
-        | Type | Description |
-        | --- | --- |
-        | `#!python str` | A string containing the root component's `#!python id`. |
+    | Type | Description |
+    | --- | --- |
+    | `#!python str` | A string containing the root component's `#!python id`. |
 
 ---
 

docs/src/reference/management-commands.md

@@ -12,7 +12,7 @@ ReactPy exposes Django management commands that can be used to perform various R
 
 Command used to manually clean ReactPy data.
 
-When using this command without arguments, it will perform all cleaning operations. You can specify only performing specific cleaning operations through arguments such as `--sessions`.
+When using this command without arguments, it will perform all cleaning operations. You can limit cleaning to specific operations through arguments such as `--sessions`.
 
 !!! example "Terminal"
 

docs/src/reference/settings.md

@@ -131,7 +131,7 @@ This setting is incompatible with [`daphne`](https://github.com/django/daphne).
 
 The default host(s) that can render your ReactPy components.
 
-ReactPy will use these hosts in a round-robin fashion, allowing for easy distributed computing.
+ReactPy will use these hosts in a round-robin fashion, allowing for easy distributed computing. This is typically useful for self-hosted applications.
 
 You can use the `#!python host` argument in your [template tag](../reference/template-tag.md#component) to manually override this default.
 
@@ -147,9 +147,10 @@ Configures whether to pre-render your components via HTTP, which enables SEO com
 
 During pre-rendering, there are some key differences in behavior:
 
-1. Only the component's first render is pre-rendered.
+1. Only the component's first paint is pre-rendered.
 2. All [`connection` hooks](https://reactive-python.github.io/reactpy-django/latest/reference/hooks/#connection-hooks) will provide HTTP variants.
 3. The component will be non-interactive until a WebSocket connection is formed.
+4. The component is re-rendered once a WebSocket connection is formed.
 
 <!-- TODO: The comment below will become true when ReactPy no longer strips scripts from the DOM -->
 <!-- 4. `#!python html.script` elements are executed twice (pre-render and post-render). -->