diff --git a/src/metpy/calc/basic.py b/src/metpy/calc/basic.py index d1d227f6309..56b60315f1d 100644 --- a/src/metpy/calc/basic.py +++ b/src/metpy/calc/basic.py @@ -246,6 +246,18 @@ def heat_index(temperature, relative_humidity, mask_undefined=True): A flag indicating whether a masked array should be returned with values masked where the temperature < 80F. Defaults to `True`. + Examples + -------- + >>> from metpy.calc import heat_index + >>> from metpy.units import units + >>> heat_index(30 * units.degC, 90 * units.percent) + + >>> heat_index(90 * units.degF, 90 * units.percent) + + >>> heat_index(60 * units.degF, 90 * units.percent) + + >>> heat_index(60 * units.degF, 90 * units.percent, mask_undefined=False) + .. versionchanged:: 1.0 Renamed ``rh`` parameter to ``relative_humidity``