From b0565e7ee1eb1b244f90cbab03ebcf4447a83eb0 Mon Sep 17 00:00:00 2001 From: Chris Dzombak Date: Thu, 18 Jul 2024 10:14:22 -0400 Subject: [PATCH] improve heat index docs in README --- README.md | 12 +++++------- temperature_types.go | 2 +- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 33b3c3f..99f8726 100644 --- 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 index fe43bdc..2772178 100644 --- 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