git.iko.soy/typeable/uuid
on master help sign in
Merge pull request #63 from pdedmon/minor-doc-fixes

minor documentation fixes

commit13a6ce46d0ea1c8fa0404e6ee35eb041ba9079bd authorOleg Grenrus <oleg.grenrus@iki.fi> dateThu 13 May 2021, 16:08 (5 years ago) parente8dc71259145e0
3 files changed+7−6
compare with master
unifiedsplit
uuid/src/Data/UUID/V1.hs+1−1 uuid/src/Data/UUID/V3.hs+1−1 uuid/src/Data/UUID/V4.hs+5−4
uuid/src/Data/UUID/V1.hs+1−1
@@ -19,7 +19,7 @@ The generated UUID is based on the hardware MAC
1919address and the system clock.
2020
2121If we cannot lookup the MAC address we seed the
22−generator with a psuedo-random number.
22+generator with a pseudo-random number.
2323-}
2424
2525module Data.UUID.V1(nextUUID)
uuid/src/Data/UUID/V3.hs+1−1
@@ -8,7 +8,7 @@ Maintainer : aslatter@gmail.com
88Stability : experimental
99Portability : portable
1010
11−NOTE: This module uses MD5 hashing. Unless you know
11+NOTE\: This module uses MD5 hashing. Unless you know
1212you need to use this module, you should probably be
1313using "Data.UUID.V5", which offers the same sort of
1414functionality as this module except implemented with
uuid/src/Data/UUID/V4.hs+5−4
@@ -11,8 +11,8 @@
1111 This module implements Version 4 UUIDs as specified
1212 in RFC 4122.
1313
14− These UUIDs are generated from a pseddo-random generator.
15− We use 'getEntropy' method from <https://hackage.haskell.org/package/entropy entropy> package,
14+ These UUIDs are generated from a pseudo-random generator.
15+ We use the 'getEntropy' method from the <https://hackage.haskell.org/package/entropy entropy> package,
1616 which should provide cryptographically secure random data.
1717-}
1818module Data.UUID.V4 (nextRandom) where
@@ -23,8 +23,9 @@ import Data.UUID.Types.Internal ( buildFromBytes )
2323import System.Entropy ( getEntropy )
2424import Data.ByteString ( unpack )
2525
26−-- | Generate a crytographically secure, random UUID. Introduced in version
27−-- 1.2.6.
26+-- | Generate a crytographically secure, random UUID.
27+--
28+-- @since 1.2.6
2829nextRandom :: IO UUID
2930nextRandom = do
3031 [b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, ba, bb, bc, bd, be, bf]