From d9013ab5f0f73498ce94e7b0e9fd9973644d413b Mon Sep 17 00:00:00 2001 From: Blake Harnden <32446120+bharnden@users.noreply.github.com> Date: Fri, 9 Aug 2024 08:27:44 -0700 Subject: [PATCH] updates to service documentation validation mode to use actual variable examples --- docs/services.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/services.md b/docs/services.md index 474f4122..e1aa9484 100644 --- a/docs/services.md +++ b/docs/services.md @@ -150,7 +150,7 @@ class ExampleService(CoreService): validate: list[str] = [] # commands to run to stop this service shutdown: list[str] = [] - # validation mode, blocking, non-blocking, and timer + # validation mode BLOCKING, NON_BLOCKING, and TIMER validation_mode: ServiceMode = ServiceMode.BLOCKING # configurable values that this service can use, for file generation default_configs: list[Configuration] = [ @@ -191,9 +191,9 @@ class ExampleService(CoreService): Validation modes are used to determine if a service has started up successfully. -* blocking - startup commands are expected to run til completion and return 0 exit code -* non-blocking - startup commands are ran, but do not wait for completion -* timer - startup commands are ran, and an arbitrary amount of time is waited to consider started +* `BLOCKING` - startup commands are expected to run til completion and return 0 exit code +* `NON_BLOCKING` - startup commands are ran, but do not wait for completion +* `TIMER` - startup commands are ran, and an arbitrary amount of time is waited to consider started #### Shadow Directories