From 4399b2f889756271295be4e6382d6ba7484d54ce Mon Sep 17 00:00:00 2001 From: Emmanuel Nwafor Date: Mon, 25 Dec 2023 22:39:35 +0100 Subject: [PATCH] fix: docstrings --- flask_status/main.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/flask_status/main.py b/flask_status/main.py index 0315789..9e7e0fc 100644 --- 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: