fix: docstrings

Emmo00 · Dec 25, 2023 · 4399b2f · 4399b2f
1 parent 4a071fb
commit 4399b2f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/flask_status/main.py b/flask_status/main.py
@@ -4,6 +4,12 @@
 
 
 class FlaskStatus:
+    """Flask status - Add status ping route to flask application
+    ```
+    FlaskStatus(app)
+    ```
+    """
+
     def __init__(
         self,
         app: Flask | None = None,
@@ -45,12 +51,14 @@ def init_app(
             @app.route(self.status_ping_url, methods=["GET"])
             @authenticator
             def status_ping():
+                """Authenticated status ping endpoint"""
                 return jsonify(self.status_message), 200
 
             return
 
         @app.route(self.status_ping_url, methods=["GET"])
         def status_ping():
+            """Status ping endpoint"""
             return jsonify(self.status_message), 200
 
     def add_field(self, key: str, value: Any) -> None: