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

docs(smtp): 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:14:01 -06:00
parent e1cd1d2674
commit b7da0e37ed
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 "code.nochebuena.dev/einherjar/smtp" import "code.nochebuena.dev/einherjar/smtp"
mailer := smtp.New(logger, smtp.DefaultConfig()) mailer := smtp.New(logger, smtp.DefaultConfig())
launcher.Append(mailer) // OnInit verifies credentials; OnStop is a no-op lc.Append(mailer) // OnInit verifies credentials; OnStop is a no-op
health.Register(mailer) // dial check; LevelDegraded // mailer is observability.Checkable (dial check, LevelDegraded):
srv.Get("/health", health.NewHandler(logger, mailer).ServeHTTP)
``` ```
When `cfg.Host` is empty, `New` returns a no-op that logs every `Send` call at debug level and always returns nil. No code changes are needed between environments. When `cfg.Host` is empty, `New` returns a no-op that logs every `Send` call at debug level and always returns nil. No code changes are needed between environments.
doc.go
+6 -2
View File
@@ -12,8 +12,12 @@
// # Lifecycle Registration // # Lifecycle Registration
// //
// client := smtp.New(logger, cfg) // client := smtp.New(logger, cfg)
// launcher.Register(client) // lc.Append(client) // lifecycle: OnInit → OnStop
// health.Register(client) //
// client satisfies [observability.Checkable], so it can back a health endpoint via
// web/health.NewHandler:
//
// srv.Get("/health", health.NewHandler(logger, client).ServeHTTP)
// //
// # Sending // # Sending
// //