einherjar/worker
2
0
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

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

Browse Source 
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:
Rene Nochebuena
2026-08-07 22:14:08 -06:00
parent 320bc2c313
commit 278eeeba5b
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -18,7 +18,7 @@
import "code.nochebuena.dev/einherjar/worker"
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