self review

Author: Archmonger

docs/examples/python/django_form_on_success.py

@@ -8,13 +8,14 @@
 
 @component
 def basic_form():
-    success, set_success = hooks.use_state(False)
+    submitted, set_submitted = hooks.use_state(False)
 
-    def on_success(event: FormEventData):
-        set_success(True)
+    def on_submit(event: FormEventData):
+        """This function will be called when the form is successfully submitted."""
+        set_submitted(True)
 
-    if not success:
-        children = [html.input({"type": "submit"})]
-        return django_form(MyForm, on_success=on_success, bottom_children=children)
+    if submitted:
+        return navigate("/homepage")
 
-    return navigate("/homepage")
+    children = [html.input({"type": "submit"})]
+    return django_form(MyForm, on_success=on_submit, bottom_children=children)

docs/src/reference/components.md

@@ -405,12 +405,12 @@ Compatible with both [standard Django forms](https://docs.djangoproject.com/en/s
 
     | Name | Type | Description | Default |
     | --- | --- | --- | --- |
-    | `#!python form` | `#!python type[Form | ModelForm]` | The form instance to convert. | N/A |
+    | `#!python form` | `#!python type[Form | ModelForm]` | The form to convert. | N/A |
     | `#!python on_success` | `#!python AsyncFormEvent | SyncFormEvent | None` | A callback function that is called when the form is successfully submitted. | `#!python None` |
     | `#!python on_error` | `#!python AsyncFormEvent | SyncFormEvent | None` | A callback function that is called when the form submission fails. | `#!python None` |
     | `#!python on_receive_data` | `#!python AsyncFormEvent | SyncFormEvent | None` | A callback function that is called before newly submitted form data is rendered. | `#!python None` |
     | `#!python on_change` | `#!python AsyncFormEvent | SyncFormEvent | None` | A callback function that is called when the form is changed. | `#!python None` |
-    | `#!python auto_save` | `#!python bool` | If `#!python True`, the form will automatically call `#!python save` on successful submission of a `#!python ModelForm`. This has no effect on regular `#!python Form` instances. | `#!python False` |
+    | `#!python auto_save` | `#!python bool` | If `#!python True`, the form will automatically call `#!python save` on successful submission of a `#!python ModelForm`. This has no effect on regular `#!python Form` instances. | `#!python True` |
     | `#!python extra_props` | `#!python dict[str, Any] | None` | Additional properties to add to the `#!html <form>` element. | `#!python None` |
     | `#!python extra_transforms` | `#!python Sequence[Callable[[VdomDict], Any]] | None` | A list of functions that transforms the newly generated VDOM. The functions will be repeatedly called on each VDOM node. | `#!python None` |
     | `#!python form_template` | `#!python str | None` | The template to use for the form. If `#!python None`, Django's default template is used. | `#!python None` |

src/reactpy_django/components.py

@@ -1,3 +1,5 @@
+"""This file contains Django related components. Most of these components utilize wrappers to fix type hints."""
+
 from __future__ import annotations
 
 import json
@@ -136,7 +138,7 @@ def django_form(
     """Converts a Django form to a ReactPy component.
 
     Args:
-        form: The form instance to convert.
+        form: The form to convert.
 
     Keyword Args:
         on_success: A callback function that is called when the form is successfully submitted.