improve heat index docs in README

cdzombak · Jul 18, 2024 · b0565e7 · b0565e7
1 parent 39b467f
commit b0565e7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -48,13 +48,11 @@ These functions return [`ErrInputRange`](https://pkg.go.dev/github.com/cdzombak/
 
 [`HeatIndexWarningF()`](https://pkg.go.dev/github.com/cdzombak/libwx#HeatIndexWarningF) and [`HeatIndexWarningC()`](https://pkg.go.dev/github.com/cdzombak/libwx#HeatIndexWarningC) provide a warning level based on the heat index. These warning levels are based on the NOAA's heat index table:
 
-```go
-HeatIndexWarningNone
-HeatIndexWarningCaution
-HeatIndexWarningExtremeCaution
-HeatIndexWarningDanger
-HeatIndexWarningExtremeDanger
-```
+- `HeatIndexWarningNone` indicates the heat index does not warrant elevated caution.
+- `HeatIndexWarningCaution` indicates fatigue is possible with prolonged exposure and activity. Continuing activity could result in heat cramps.
+- `HeatIndexWarningExtremeCaution` indicates heat cramps and heat exhaustion are possible. Continuing activity could result in heat stroke.
+- `HeatIndexWarningDanger` indicates heat cramps and heat exhaustion are likely; heat stroke is probable with continued activity.
+- `HeatIndexWarningExtremeDanger` indicates heat stroke is imminent.
 
 ### Distance types & conversions
 

diff --git a/temperature_types.go b/temperature_types.go
@@ -18,7 +18,7 @@ const (
 	HeatIndexWarningCaution
 	// HeatIndexWarningExtremeCaution indicates heat cramps and heat exhaustion are possible. Continuing activity could result in heat stroke.
 	HeatIndexWarningExtremeCaution
-	// HeatIndexWarningDangerindicates heat cramps and heat exhaustion are likely; heat stroke is probable with continued activity.
+	// HeatIndexWarningDanger indicates heat cramps and heat exhaustion are likely; heat stroke is probable with continued activity.
 	HeatIndexWarningDanger
 	// HeatIndexWarningExtremeDanger indicates heat stroke is imminent.
 	HeatIndexWarningExtremeDanger