From 3fc3ee8feba400c37528f4963f3d9e0d98f3f0aa Mon Sep 17 00:00:00 2001 From: Rene Nochebuena Guerrero Date: Fri, 7 Aug 2026 22:13:57 -0600 Subject: [PATCH] docs(db-sqlite): 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. 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. --- README.md | 5 +++-- doc.go | 8 ++++++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3505fa..cc43e7d 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,9 @@ import dbsqlite "code.nochebuena.dev/einherjar/db-sqlite" db := dbsqlite.New(logger, dbsqlite.DefaultConfig()) -launcher.Append(db) // OnInit opens database; OnStop closes it -health.Register(db) // BucketExists-style check; LevelDegraded +lc.Append(db) // OnInit opens database; OnStop closes it +// db is observability.Checkable (LevelDegraded): +srv.Get("/health", health.NewHandler(logger, db).ServeHTTP) ``` ### Querying diff --git a/doc.go b/doc.go index 5587b8d..982c64c 100644 --- a/doc.go +++ b/doc.go @@ -15,8 +15,12 @@ // # Lifecycle Registration // // db := sqlite.New(logger, cfg) -// launcher.Register(db) -// health.Register(db) +// lc.Append(db) // lifecycle: OnInit → OnStart → OnStop +// +// db satisfies [observability.Checkable], so it can back a health endpoint via +// web/health.NewHandler: +// +// srv.Get("/health", health.NewHandler(logger, db).ServeHTTP) // // # Querying //