self review cleanup

Author: Archmonger

src/reactpy_django/auth/components.py

@@ -52,17 +52,15 @@ async def synchronize_session_watchdog():
             set_synchronize_requested(False)
 
     async def synchronize_session():
-        """Entrypoint where the server will command the client to switch HTTP sessions
-        to match the websocket session. This function is stored in the websocket scope so that
-        ReactPy-Django's hooks can access it."""
+        """Event that can command the client to switch HTTP sessions (to match the websocket sessions)."""
         session: SessionBase | None = scope.get("session")
         if not session or not session.session_key:
             return
 
         # Delete any sessions currently associated with the previous UUID.
         # This exists to fix scenarios where...
-        # 1) A component tree performs multiple login commands for different users.
-        # 2) A login is requested, but the server failed to respond to the HTTP request.
+        # 1) Login is called multiple times before the first one is completed.
+        # 2) Login was called, but the server failed to respond to the HTTP request.
         if uuid.current:
             with contextlib.suppress(SynchronizeSession.DoesNotExist):
                 obj = await SynchronizeSession.objects.aget(uuid=uuid.current)

src/reactpy_django/hooks.py

@@ -418,15 +418,15 @@ def use_root_id() -> str:
 
 
 def use_auth():
-    """Provides the ability to login/logout a user using Django's standard authentication framework."""
+    """Provides the ability to login/logout a user using Django's authentication framework."""
     from reactpy_django import config
 
     scope = use_scope()
 
     async def login(user: AbstractUser):
         await channels_auth.login(scope, user, backend=config.REACTPY_AUTH_BACKEND)
-        session_save_func = getattr(scope["session"], "asave", scope["session"].save)
-        await ensure_async(session_save_func)()
+        session_save_method = getattr(scope["session"], "asave", scope["session"].save)
+        await ensure_async(session_save_method)()
         await scope["reactpy"]["synchronize_session"]()
 
     async def logout(rerender: bool = True):

src/reactpy_django/models.py

@@ -21,7 +21,7 @@ class ComponentSession(models.Model):
 
 
 class SynchronizeSession(models.Model):
-    """A model for stores any relevant data needed to force Django's HTTP session to
+    """A model that contains any relevant data needed to force Django's HTTP session to
     match the websocket session.
 
     This data is tied to an arbitrary UUID for security (obfuscation) purposes.