Clean up documentation
authorAshley Yakeley <ashley@semantic.org>
Fri, 15 Mar 2019 08:08:44 +0000 (01:08 -0700)
committerAshley Yakeley <ashley@semantic.org>
Fri, 15 Mar 2019 08:08:44 +0000 (01:08 -0700)
lib/Data/Time/Clock/Internal/NominalDiffTime.hs
lib/Data/Time/Clock/POSIX.hs

index c919eab..70c3721 100644 (file)
@@ -16,9 +16,11 @@ import Control.DeepSeq
 
 
 -- | This is a length of time, as measured by UTC.
+-- It has a precision of 10^-12 s.
+--
 -- Conversion functions will treat it as seconds.
 -- For example, @(0.010 :: NominalDiffTime)@ corresponds to 10 milliseconds.
--- It has a precision of 10^-12 s.
+--
 -- It ignores leap-seconds, so it's not necessarily a fixed amount of clock time.
 -- For instance, 23:00 UTC + 2 hours of NominalDiffTime = 01:00 UTC (+ 1 day),
 -- regardless of whether a leap-second intervened.
index f207c73..edd2024 100644 (file)
@@ -1,21 +1,20 @@
 -- | POSIX time, if you need to deal with timestamps and the like.
 -- Most people won't need this module.
 --
--- If you want to convert POSIX time to integer/word timestamps,
--- consider the following example:
+-- You can use 'POSIXTime' to obtain integer/word timestamps. For example:
 --
--- > import           Data.Time.Clock (UTCTime, getCurrentTime, nominalDiffTimeToSeconds)
--- > import           Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
--- > import           Data.Int (Int64)
+-- > import Data.Time
+-- > import Data.Time.Clock.POSIX
+-- > import Data.Int
 -- >
 -- > nanosSinceEpoch :: UTCTime -> Int64
 -- > nanosSinceEpoch =
--- >   floor . (1e9 *) . nominalDiffTimeToSeconds . utcTimeToPOSIXSeconds
+-- >     floor . (1e9 *) . nominalDiffTimeToSeconds . utcTimeToPOSIXSeconds
 -- >
 -- > main :: IO ()
 -- > main = do
--- >   u <- getCurrentTime :: IO UTCTime
--- >   print (nanosSinceEpoch u)
+-- >     u <- getCurrentTime
+-- >     print $ nanosSinceEpoch u
 module Data.Time.Clock.POSIX
 (
     posixDayLength,POSIXTime,posixSecondsToUTCTime,utcTimeToPOSIXSeconds,getPOSIXTime,getCurrentTime,