Skip to content

Commit f4e5f08

Browse files
nbacqueycarbolymer
authored andcommitted
Fix haddock for byDeadline and byDuration
1 parent 13ee010 commit f4e5f08

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/Hedgehog/Extras/Test/Base.hs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -498,13 +498,13 @@ jsonErrorFail r = GHC.withFrozenCallStack $ case r of
498498
jsonErrorFailM :: (MonadTest m, HasCallStack) => m (Result a) -> m a
499499
jsonErrorFailM f = GHC.withFrozenCallStack $ f >>= jsonErrorFail
500500

501-
-- | Run the operation 'f' once a second until it returns 'True' or the deadline expires.
501+
-- | Run the operation 'f' once per 'period' until it returns 'True' or the deadline expires.
502502
--
503503
-- Expiration of the deadline results in an assertion failure
504504
byDeadlineIO :: (MonadAssertion m, MonadTest m, MonadIO m, HasCallStack) => NominalDiffTime -> UTCTime -> String -> IO a -> m a
505505
byDeadlineIO period deadline errorMessage f = GHC.withFrozenCallStack $ byDeadlineM period deadline errorMessage $ liftIO f
506506

507-
-- | Run the operation 'f' once a second until it returns 'True' or the deadline expires.
507+
-- | Run the operation 'f' once per 'period' until it returns 'True' or the deadline expires.
508508
--
509509
-- Expiration of the deadline results in an assertion failure
510510
byDeadlineM :: forall m a. (MonadAssertion m, MonadTest m, MonadIO m, HasCallStack) => NominalDiffTime -> UTCTime -> String -> m a -> m a
@@ -526,13 +526,13 @@ byDeadlineM period deadline errorMessage f = GHC.withFrozenCallStack $ do
526526
void $ failMessage GHC.callStack $ "Condition not met by deadline: " <> errorMessage
527527
H.throwAssertion e
528528

529-
-- | Run the operation 'f' once a second until it returns 'True' or the duration expires.
529+
-- | Run the operation 'f' once per 'period' until it returns 'True' or the duration expires.
530530
--
531531
-- Expiration of the duration results in an assertion failure
532532
byDurationIO :: (MonadAssertion m, MonadTest m, MonadIO m, HasCallStack) => NominalDiffTime -> NominalDiffTime -> String -> IO a -> m a
533533
byDurationIO period duration errorMessage f = GHC.withFrozenCallStack $ byDurationM period duration errorMessage $ liftIO f
534534

535-
-- | Run the operation 'f' once a second until it returns 'True' or the duration expires.
535+
-- | Run the operation 'f' once per 'period' until it returns 'True' or the duration expires.
536536
--
537537
-- Expiration of the duration results in an assertion failure
538538
byDurationM :: (MonadAssertion m, MonadTest m, MonadIO m, HasCallStack) => NominalDiffTime -> NominalDiffTime -> String -> m a -> m a

0 commit comments

Comments
 (0)