docs(worker): fix fictional launcher.Register/health.Register in doc examples (#2)
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. Reviewed-on: #2 Co-authored-by: Rene Nochebuena Guerrero <rene@nochebuena.dev> Co-committed-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
This commit was merged in pull request #2.
This commit is contained in:
@@ -9,10 +9,10 @@
|
||||
// ShutdownTimeout for all goroutines to finish. Returns nil regardless of
|
||||
// whether the drain completed before the deadline.
|
||||
//
|
||||
// Register with the launcher before starting:
|
||||
// Append to a launcher before starting:
|
||||
//
|
||||
// pool := worker.New(logger, cfg)
|
||||
// launcher.Register(pool)
|
||||
// lc.Append(pool)
|
||||
//
|
||||
// # Dispatching Tasks
|
||||
//
|
||||
|
||||
Reference in New Issue
Block a user