self review

Author: Archmonger

CHANGELOG.md

@@ -37,10 +37,10 @@ Using the following categories, list your changes in this order:
 ### Added
 
 -   Client-side Python components can now be rendered via the new `{% pyscript_component %}` template tag
--   PyScript's can be made accessible for an existing page using the `{% pyscript_setup %}` template tag
-    -   This tag can also be used to load additional dependencies, or change the default PyScript configuration.
+    -   You must first call the `{% pyscript_setup %}` template tag to load PyScript dependencies
 -   Client-side components can be embedded into existing server-side components via `reactpy_django.components.pyscript_component`.
--   You can now write Python code that runs within client browser via the `reactpy_django.html.pyscript` element. This is a viable substitution for most JavaScript code.
+-   Tired of writing JavaScript? You can now write PyScript code that runs directly within client browser via the `reactpy_django.html.pyscript` element.
+    -   This is a viable substitution for most JavaScript code.
 
 ### Changed
 
@@ -56,7 +56,7 @@ Using the following categories, list your changes in this order:
 
 ### Removed
 
--   `QueryOptions` and `MutationOptions` have been removed. Their values are now passed direct into the hook.
+-   `QueryOptions` and `MutationOptions` have been removed. The value contained within these objects are now passed directly into the hook.
 
 ### Fixed
 

docs/src/reference/router.md

@@ -20,7 +20,7 @@ URL router that enables the ability to conditionally render other components bas
 
 !!! warning "Pitfall"
 
-    All pages where `django_router` is used must have the same, or more permissive URL exposure within Django's [URL patterns](https://docs.djangoproject.com/en/5.0/topics/http/urls/#example). You can think of this component as a secondary, client-side router. Django still handles the primary server-side routes.
+    All pages where `django_router` is used must have identical, or more permissive URL exposure within Django's [URL patterns](https://docs.djangoproject.com/en/5.0/topics/http/urls/#example). You can think of the router component as a secondary, client-side router. Django still handles the primary server-side routes.
 
     We recommend creating a route with a wildcard `.*` to forward routes to ReactPy. For example...
     `#!python re_path(r"^/router/.*$", my_reactpy_view)`

docs/src/reference/template-tag.md

@@ -225,11 +225,13 @@ Your PyScript component file requires a `#!python def root()` component to funct
 
 ??? question "Does my entire component need to be contained in one file?"
 
-    PyScript components do not have access to your local disk, and thus cannot `#!python import` any local Python modules.
+    Splitting a large file into multiple files is a common practice in software development.
 
-    To bypass this, you can declare multiple file paths. These files will automatically combined during processing.
+    However, PyScript components are run on the client browser. As such, they do not have access to your local development environment, and thus cannot `#!python import` any local Python files.
 
-    Here is how we recommend doing that while retaining type hints.
+    If your PyScript component file gets too large, you can declare multiple file paths instead. These files will automatically combined by ReactPy.
+
+    Here is how we recommend splitting your component into multiple files while avoiding local imports but retaining type hints.
 
     <!--pyscript-multifile-end-->
 
@@ -295,9 +297,9 @@ Your PyScript component file requires a `#!python def root()` component to funct
 
 ## PyScript Setup
 
-This template tag configures the current page to be able to run `pyscript` by loading PyScript's static files.
+This template tag configures the current page to be able to run `pyscript`.
 
-You can optionally include a list of Python packages to install within the PyScript environment, or a [PyScript configuration dictionary](https://docs.pyscript.net/2024.6.1/user-guide/configuration/).
+You can optionally use this tag to configure the current PyScript enviroment. For example, you can include a list of Python packages to automatically install within the PyScript environment.
 
 === "my_template.html"
 

src/reactpy_django/components.py

@@ -327,9 +327,8 @@ def _pyscript_component(
     executor = render_pyscript_template(file_paths, uuid, root)
 
     if not rendered:
-        # FIXME: This is needed to properly re-render PyScript such as
-        # during a WebSocket disconnection / reconnection.
-        # There may be a better way to do this in the future.
+        # FIXME: This is needed to properly re-render PyScript during a WebSocket
+        # disconnection / reconnection. There may be a better way to do this in the future.
         set_rendered(True)
         return None
 

src/reactpy_django/pyscript/component_template.py

@@ -14,7 +14,7 @@ def user_workspace_UUID():
     This code is designed to be run directly by PyScript, and is not intended to be run
     in a normal Python environment.
 
-    ReactPy-Django's template tag performs string substitutions to turn this file into valid PyScript.
+    ReactPy-Django performs string substitutions to turn this file into valid PyScript.
     """
 
     def root(): ...