Skip to content

Commit 7650f13

Browse files
committed
Add missing docstrings
1 parent 7cd7388 commit 7650f13

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

src/reactpy/asgi/middleware.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,14 @@ def __init__(
3838
**settings: Unpack[ReactPyConfig],
3939
) -> None:
4040
"""Configure the ASGI app. Anything initialized in this method will be shared across all future requests.
41-
TODO: Add types in docstring"""
41+
42+
Parameters:
43+
app: The ASGI application to serve when the request does not match a ReactPy route.
44+
root_components:
45+
A list, set, or tuple containing the dotted path of your root components. This dotted path
46+
must be valid to Python's import system.
47+
settings: Global ReactPy configuration settings that affect behavior and performance.
48+
"""
4249
# Process global settings
4350
process_settings(settings)
4451

src/reactpy/asgi/standalone.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,15 @@ def __init__(
3535
html_lang: str = "en",
3636
**settings: Unpack[ReactPyConfig],
3737
) -> None:
38-
"""TODO: Add docstring"""
38+
"""ReactPy's standalone ASGI application.
39+
40+
Parameters:
41+
root_component: The root component to render. This component is assumed to be a single page application.
42+
http_headers: Additional headers to include in the HTTP response for the base HTML document.
43+
html_head: Additional head elements to include in the HTML response.
44+
html_lang: The language of the HTML document.
45+
settings: Global ReactPy configuration settings that affect behavior and performance.
46+
"""
3947
super().__init__(app=ReactPyApp(self), root_components=[], **settings)
4048
self.root_component = root_component
4149
self.extra_headers = http_headers or {}

0 commit comments

Comments
 (0)