From 8f7e966e6dc6c7773f2340deabb4f0e2a2ab0873 Mon Sep 17 00:00:00 2001 From: Frank Wiles Date: Wed, 31 Jan 2024 08:53:34 -0600 Subject: [PATCH] Correct docs after subset argument removal --- README.md | 4 ++-- docs/readme.rst | 2 +- health_check/mixins.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 253f15db..833fd270 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ To use Health Check Subsets, Specify a subset name and associate it with the rel "SUBSETS": { "startup-probe": ["MigrationsHealthCheck", "DatabaseBackend"], "liveness-probe": ["DatabaseBackend"], - "": ["": [""] }, # ..... } @@ -192,7 +192,7 @@ Writing a health check is quick and easy: #: even if the check errors. critical_service = False - def check_status(self, subset=None): + def check_status(self): # The test code goes here. # You can use `self.add_error` or # raise a `HealthCheckException`, diff --git a/docs/readme.rst b/docs/readme.rst index 618aaa1f..b538529f 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -181,7 +181,7 @@ Writing a health check is quick and easy: #: even if the check errors. critical_service = False - def check_status(self, subset=None): + def check_status(self): # The test code goes here. # You can use `self.add_error` or # raise a `HealthCheckException`, diff --git a/health_check/mixins.py b/health_check/mixins.py index dd04180c..139707c4 100644 --- a/health_check/mixins.py +++ b/health_check/mixins.py @@ -46,7 +46,7 @@ def filter_plugins(self, subset=None): health_check_subsets = HEALTH_CHECK["SUBSETS"] if subset not in health_check_subsets or not self.plugins: - raise Http404(f"Specify subset: '{subset}' does not exists.") + raise Http404(f"Subset: '{subset}' does not exist.") selected_subset = set(health_check_subsets[subset]) return {