Skip to content

Commit 8f7e966

Browse files
committed
Correct docs after subset argument removal
1 parent 4d04b5a commit 8f7e966

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ To use Health Check Subsets, Specify a subset name and associate it with the rel
9797
"SUBSETS": {
9898
"startup-probe": ["MigrationsHealthCheck", "DatabaseBackend"],
9999
"liveness-probe": ["DatabaseBackend"],
100-
"<SUBSET_NAME>": ["<Health_Check_Service_Name"]
100+
"<SUBSET_NAME>": ["<Health_Check_Service_Name>"]
101101
},
102102
# .....
103103
}
@@ -192,7 +192,7 @@ Writing a health check is quick and easy:
192192
#: even if the check errors.
193193
critical_service = False
194194

195-
def check_status(self, subset=None):
195+
def check_status(self):
196196
# The test code goes here.
197197
# You can use `self.add_error` or
198198
# raise a `HealthCheckException`,

docs/readme.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Writing a health check is quick and easy:
181181
#: even if the check errors.
182182
critical_service = False
183183
184-
def check_status(self, subset=None):
184+
def check_status(self):
185185
# The test code goes here.
186186
# You can use `self.add_error` or
187187
# raise a `HealthCheckException`,

health_check/mixins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def filter_plugins(self, subset=None):
4646

4747
health_check_subsets = HEALTH_CHECK["SUBSETS"]
4848
if subset not in health_check_subsets or not self.plugins:
49-
raise Http404(f"Specify subset: '{subset}' does not exists.")
49+
raise Http404(f"Subset: '{subset}' does not exist.")
5050

5151
selected_subset = set(health_check_subsets[subset])
5252
return {

0 commit comments

Comments
 (0)