Skip to content

Commit

Permalink
Brick.Animation.Clock: add module haddock
Browse files Browse the repository at this point in the history
  • Loading branch information
jtdaugherty committed Jan 3, 2025
1 parent c3d2d3d commit ebf255e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/Brick/Animation/Clock.hs
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
-- | This module provides an API for working with
-- 'Data.Time.Clock.System.SystemTime' values similar to that of
-- 'Data.Time.Clock.UTCTime'. @SystemTime@s are more efficient to
-- obtain than @UTCTime@s, which is important to avoid animation
-- tick thread delays associated with expensive clock reads. In
-- addition, the @UTCTime@-based API provides unpleasant @Float@-based
-- conversions. Since the @SystemTime@-based API doesn't provide some
-- of the operations we need, and since it is easier to work with at
-- millisecond granularity, it is extended here for internal use.
module Brick.Animation.Clock
( Time
, getTime
Expand Down

0 comments on commit ebf255e

Please sign in to comment.