Improve documentation

alexliesenfeld · Jul 18, 2023 · 7e10f63 · 7e10f63
1 parent 19bc5f8
commit 7e10f63
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/examples/showcase/main.go b/examples/showcase/main.go
@@ -49,7 +49,7 @@ func main() {
 		// call and do some pre- and post-processing, having the check state and check function result at hand.
 		health.WithInterceptors(interceptors.BasicLogger()),
 
-		// Set service info that will be included in all check results.
+		// Set service information to be included in all check results.
 		health.WithInfo(map[string]any{
 			"version":     "v0.0.8",
 			"environment": "production",

diff --git a/examples/simple/main.go b/examples/simple/main.go
@@ -25,12 +25,10 @@ func main() {
 		// Configure a global timeout that will be applied to all checks.
 		health.WithTimeout(10*time.Second),
 
-		// Set service info that will be included in all check results.
-		// Will be available in the "info" field of the JSON response body.
+		// Set service information to be included in all check results.
 		health.WithInfo(map[string]any{
 			"version":     "v0.0.1",
 			"environment": "production",
-			"SHA":         "0719f0e2275e07077237ddb55c86ad2e52543555",
 		}),
 
 		// A check configuration to see if our database connection is up.