Adding docstrings

VectorInstitute · Feb 16, 2024 · 04fa3e6 · 04fa3e6
1 parent 3eeec77
commit 04fa3e6
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/florist/api/client.py b/florist/api/client.py
@@ -6,4 +6,9 @@
 
 @app.get("/api/client/connect")
 def connect() -> JSONResponse:
+    """
+    Confirms the client is up and ready to accept instructions.
+
+    :return: JSON `{"status": "ok"}`
+    """
     return JSONResponse({"status": "ok"})