Skip to content

Commit

Permalink
Fix incorrect text in Haddock
Browse files Browse the repository at this point in the history
  • Loading branch information
jvnknvlgl committed Aug 2, 2024
1 parent fd790c0 commit efb3cc6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions clash-prelude/src/Clash/Class/Resize.hs
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ maybeIntegral Proxy v =
&& toInteger v > toInteger (minBound @b)

-- | Like 'fromIntegral', but returns 'Nothing' if /a/ is out of bounds for /b/.
-- Useful when you "know" /a/ can't be out of bounds, but would like to have your
-- assumptions checked.
-- Useful when you do not know /a/ can be out of bounds, and would like to have
-- your assumptions checked.
--
-- * __NB__: Check only affects simulation. I.e., no checks will be inserted
-- into the generated HDL
Expand All @@ -150,8 +150,8 @@ maybeFromIntegral v =
else Nothing

-- | Like 'resize', but returns 'Nothing' if /f a/ is out of bounds for /f b/.
-- Useful when you "know" /f a/ can't be out of bounds, but would like to have your
-- assumptions checked.
-- Useful when you do not know /f a/ can be out of bounds, and would like to
-- have your assumptions checked.
--
-- __NB__: Check only affects simulation. I.e., no checks will be inserted
-- into the generated HDL
Expand All @@ -167,8 +167,8 @@ maybeResize v =
else Nothing

-- | Like 'truncateB', but returns 'Nothing' if /f (a + b)/ is out of bounds for
-- /f a/. Useful when you "know" /f (a + b)/ can't be out of bounds, but would
-- like to have your assumptions checked.
-- /f a/. Useful when you do not know /f (a + b)/ can be out of bounds, and
-- would like to have your assumptions checked.
--
-- __NB__: Check only affects simulation. I.e., no checks will be inserted
-- into the generated HDL
Expand Down

0 comments on commit efb3cc6

Please sign in to comment.