Add types to "Quick Start" haddock (#82), fix some other haddock.
authorAshley Yakeley <ashley@semantic.org>
Tue, 16 Jan 2018 01:46:51 +0000 (17:46 -0800)
committerAshley Yakeley <ashley@semantic.org>
Tue, 16 Jan 2018 01:46:51 +0000 (17:46 -0800)
lib/Data/Time.hs
lib/Data/Time/Calendar/CalendarDiffDays.hs
lib/Data/Time/LocalTime/Internal/CalendarDiffTime.hs

index eaa1d9d..607ad28 100644 (file)
@@ -7,13 +7,16 @@ Use these types for time regardless of location (not caring about leap-seconds):
 * 'UTCTime' for actual times
 * 'NominalDiffTime' for differences between times, i.e. durations
 
-Use these types for the ways people refer to time:
+Use these types for the ways people refer to time and time differences:
 
 * 'Day' for something like June 27th 2017
+* 'DayOfWeek' for something like Tuesday
 * 'TimeOfDay' for something like 5pm
 * 'LocalTime' for a 'Day' with a 'TimeOfDay'
 * 'TimeZone' for a time zone offset (not actually the time zone itself) like -0700
 * 'ZonedTime' for a 'LocalTime' with a 'TimeZone'
+* 'CalendarDiffDays' for something like 6 years, 1 month and 5 days
+* 'CalendarDiffTime' for something like 6 years, 1 month, 5 days, 3 hours, 7 minutes and 25.784 seconds
 
 Use this for low-latency timing:
 
index 3b80947..b700def 100644 (file)
@@ -34,7 +34,7 @@ instance Monoid CalendarDiffDays where
     mappend (CalendarDiffDays m1 d1) (CalendarDiffDays m2 d2) = CalendarDiffDays (m1 + m2) (d1 + d2)
 #endif
 
--- | Show in ISO 8601 "PyyYmmMddD" format. (Zero items will be omitted, except zero time will be "P0D".)
+-- | Show in ISO 8601 \"PyyYmmMddD\" format. (Zero items will be omitted, except zero time will be \"P0D\".)
 instance Show CalendarDiffDays where
     show dur@(CalendarDiffDays m d) = let
         (y,my) = quotRem m 12
@@ -43,7 +43,7 @@ instance Show CalendarDiffDays where
         ds = if d == 0 then "" else show d ++ "D"
         in if dur == mempty then "P0D" else "P" ++ ys ++ ms ++ ds
 
--- | Read in ISO 8601 "PyyYmmMwwWddD" format. (Items may be omitted.)
+-- | Read in ISO 8601 \"PyyYmmMwwWddD\" format. (Items may be omitted.)
 instance Read CalendarDiffDays where
     readsPrec _ = readParen False $ readP_to_S $ skipSpaces >> do
         let
index ff01bca..91d8502 100644 (file)
@@ -34,7 +34,7 @@ instance Monoid CalendarDiffTime where
 #else
     mappend (CalendarDiffTime m1 d1) (CalendarDiffTime m2 d2) = CalendarDiffTime (m1 + m2) (d1 + d2)
 #endif
--- | Show in ISO 8601 "PyyYmmMddDThhHmmMssS" format.
+-- | Show in ISO 8601 \"PyyYmmMddDThhHmmMssS\" format. (Zero items will be omitted, and a zero time part with be entirely omitted, except zero time will be \"P0D\".)
 instance Show CalendarDiffTime where
     show (CalendarDiffTime months t) = let
         part :: (Eq t, Num t, Show t) => t -> String -> String
@@ -64,7 +64,7 @@ instance Show CalendarDiffTime where
                (_, "") -> dpart
                (_, _) -> dpart ++ "T" ++ tpart
 
--- | Read in ISO 8601 "PyyYmmMwwWddDThhHmmMssS" format. (Items may be omitted, and the \"T\" time section may be entirely omitted.)
+-- | Read in ISO 8601 \"PyyYmmMwwWddDThhHmmMssS\" format. (Items may be omitted, and the \"T\" time section may be entirely omitted.)
 instance Read CalendarDiffTime where
     readsPrec _ =
         readParen False $
@@ -112,6 +112,6 @@ instance Read CalendarDiffTime where
 calendarTimeDays :: CalendarDiffDays -> CalendarDiffTime
 calendarTimeDays (CalendarDiffDays m d) = CalendarDiffTime m $ fromInteger d * nominalDay
 
--- | Scale by a factor. Note that @scaleCalendarDiffDays (-1)@ will not perfectly invert a duration, due to variable month lengths.
+-- | Scale by a factor. Note that @scaleCalendarDiffTime (-1)@ will not perfectly invert a duration, due to variable month lengths.
 scaleCalendarDiffTime :: Integer -> CalendarDiffTime -> CalendarDiffTime
 scaleCalendarDiffTime k (CalendarDiffTime m d) = CalendarDiffTime (k * m) (fromInteger k * d)