Skip to content

Commit

Permalink
Correct docs after subset argument removal
Browse files Browse the repository at this point in the history
  • Loading branch information
frankwiles committed Jan 31, 2024
1 parent 4d04b5a commit 8f7e966
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
"<SUBSET_NAME>": ["<Health_Check_Service_Name"]
"<SUBSET_NAME>": ["<Health_Check_Service_Name>"]
},
# .....
}
Expand Down Expand Up @@ -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`,
Expand Down
2 changes: 1 addition & 1 deletion docs/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
2 changes: 1 addition & 1 deletion health_check/mixins.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 8f7e966

Please sign in to comment.