cleanup

pydantic · Nov 30, 2023 · b901e5c · b901e5c
1 parent ab691ea
commit b901e5c
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 9 deletions.
diff --git a/packages/fastui-bootstrap/README.md b/packages/fastui-bootstrap/README.md
@@ -1,3 +1,3 @@
 # FastUI Bootstrap
 
-Bootstrap components for FastUI.
+Bootstrap components for [FastUI](https://github.com/samuelcolvin/FastUI).
diff --git a/packages/fastui-prebuilt/vite.config.ts b/packages/fastui-prebuilt/vite.config.ts
@@ -13,6 +13,7 @@ export default () => {
   }
 
   return defineConfig({
+    // @ts-expect-error - no need to type check this file
     plugins: [react()],
     resolve: {
       alias: {

diff --git a/packages/fastui/README.md b/packages/fastui/README.md
@@ -1,8 +1,3 @@
 # FastUI
 
-[![CI](https://github.com/samuelcolvin/FastUI/actions/workflows/ci.yml/badge.svg)](https://github.com/samuelcolvin/FastUI/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)
-[![pypi](https://img.shields.io/pypi/v/fastui.svg)](https://pypi.python.org/pypi/fastui)
-[![versions](https://img.shields.io/pypi/pyversions/fastui.svg)](https://github.com/samuelcolvin/FastUI)
-[![license](https://img.shields.io/github/license/samuelcolvin/FastUI.svg)](https://github.com/samuelcolvin/FastUI/blob/main/LICENSE)
-
-WIP
+[FastUI](https://github.com/samuelcolvin/FastUI) React library.
diff --git a/python/demo/main.py b/python/demo/main.py
@@ -245,6 +245,6 @@ async def sse_generator() -> AsyncIterable[str]:
         await asyncio.sleep(0.09)
 
 
-@router.get('/sse', response_class=StreamingResponse)
-async def sse_experiment():
+@router.get('/sse')
+async def sse_experiment() -> StreamingResponse:
     return StreamingResponse(sse_generator(), media_type='text/event-stream')
diff --git a/python/fastui/__init__.py b/python/fastui/__init__.py
@@ -7,6 +7,10 @@
 
 
 class FastUI(pydantic.RootModel):
+    """
+    The root component of a FastUI application.
+    """
+
     root: list[AnyComponent]
 
 
@@ -15,6 +19,15 @@ class FastUI(pydantic.RootModel):
 
 
 def prebuilt_html(title: str = ''):
+    """
+    Returns a very simple HTML page which includes the FastUI react frontend, loaded from https://www.jsdelivr.com/.
+
+    Arguments:
+        title: page title
+
+    Returns:
+        HTML string which can be returned by an endpoint to serve the FastUI frontend.
+    """
     # language=HTML
     return f"""\
 <!doctype html>