einherjar/db-mysql
2
0
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

docs(db-mysql): 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.

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:13:54 -06:00
parent 9191751d57
commit 68821284c9
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -2
View File
@@ -19,8 +19,9 @@
import dbmysql "code.nochebuena.dev/einherjar/db-mysql" import dbmysql "code.nochebuena.dev/einherjar/db-mysql"
db := dbmysql.New(logger, dbmysql.DefaultConfig()) db := dbmysql.New(logger, dbmysql.DefaultConfig())
launcher.Append(db) // OnInit opens pool; OnStop closes it lc.Append(db) // OnInit opens pool; OnStop closes it
health.Register(db) // PING health check; LevelCritical // db is observability.Checkable (PING health check, LevelCritical):
srv.Get("/health", health.NewHandler(logger, db).ServeHTTP)
``` ```
### Querying ### Querying
doc.go
+6 -2
View File
@@ -14,8 +14,12 @@
// # Lifecycle Registration // # Lifecycle Registration
// //
// db := mysql.New(logger, cfg) // db := mysql.New(logger, cfg)
// launcher.Register(db) // lc.Append(db) // lifecycle: OnInit → OnStart → OnStop
// health.Register(db) //
// db satisfies [observability.Checkable], so it can back a health endpoint via
// web/health.NewHandler:
//
// srv.Get("/health", health.NewHandler(logger, db).ServeHTTP)
// //
// # Querying // # Querying
// //