Document lack of "instance Eq ZonedTime" (#109)
authorAshley Yakeley <ashley@semantic.org>
Fri, 15 Mar 2019 08:10:41 +0000 (01:10 -0700)
committerAshley Yakeley <ashley@semantic.org>
Fri, 15 Mar 2019 08:10:41 +0000 (01:10 -0700)
lib/Data/Time/LocalTime/Internal/ZonedTime.hs

index 6cb9296..6c57a53 100644 (file)
@@ -14,6 +14,10 @@ import Data.Time.LocalTime.Internal.LocalTime
 
 
 -- | A local time together with a time zone.
+--
+-- There is no 'Eq' instance for @ZonedTime@.
+-- If you want to compare local times, use 'zonedTimeToLocalTime'.
+-- If you want to compare absolute times, use 'zonedTimeToUTC'.
 data ZonedTime = ZonedTime {
     zonedTimeToLocalTime :: LocalTime,
     zonedTimeZone :: TimeZone