docs(worker): fix fictional launcher.Register/health.Register in doc examples

The package-doc examples showed a fictional launcher.Register / health.Register
API (and launcher.Append as a package func). Corrected to the real wiring:
lc.Append + web/health.NewHandler(...).ServeHTTP.
worker exposes lc.Append only — it is not observability.Checkable, so no health hook.

Documentation-only. No code, API, or dependency changes; version stays v1.1.0
(the v1.1.0 tag is moved to include this fix). Verified by compiling the
corrected pattern against the real API.
This commit is contained in:
2026-08-07 22:14:08 -06:00
parent 320bc2c313
commit 278eeeba5b
3 changed files with 4 additions and 4 deletions
+1 -1
View File
@@ -18,7 +18,7 @@
import "code.nochebuena.dev/einherjar/worker" import "code.nochebuena.dev/einherjar/worker"
w := worker.New(logger, worker.DefaultConfig()) w := worker.New(logger, worker.DefaultConfig())
launcher.Append(w) // OnInit starts pool; OnStop drains and stops lc.Append(w) // OnInit starts pool; OnStop drains and stops
``` ```
### Dispatching tasks ### Dispatching tasks
+1 -1
View File
@@ -6,7 +6,7 @@ import (
) )
// Component adds lifecycle management to Provider. // Component adds lifecycle management to Provider.
// Register with launcher.Register before starting. // Append it to a launcher (lc.Append) before starting.
type Component interface { type Component interface {
lifecycle.Component lifecycle.Component
observability.Identifiable observability.Identifiable
+2 -2
View File
@@ -9,10 +9,10 @@
// ShutdownTimeout for all goroutines to finish. Returns nil regardless of // ShutdownTimeout for all goroutines to finish. Returns nil regardless of
// whether the drain completed before the deadline. // whether the drain completed before the deadline.
// //
// Register with the launcher before starting: // Append to a launcher before starting:
// //
// pool := worker.New(logger, cfg) // pool := worker.New(logger, cfg)
// launcher.Register(pool) // lc.Append(pool)
// //
// # Dispatching Tasks // # Dispatching Tasks
// //