bip39

commit c4cf6632321e2cd058e16b3757495560197de527
parent b6e35cc6e3279317e0187a0713330e8843fe8e96
Author: Jared Tobin <jared@jtobin.io>
Date:   Thu, 27 Feb 2025 22:41:59 +0400

lib: minor haddock fixes

Diffstat:
M
lib/Crypto/KDF/BIP39.hs
 | 
10
+++++-----

1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/lib/Crypto/KDF/BIP39.hs b/lib/Crypto/KDF/BIP39.hs
@@ -66,9 +66,9 @@ newtype Wordlist = Wordlist (PA.Array T.Text)
 -- | Generate a BIP39 mnemonic from some entropy, using the default English
 --   wordlist.
 --
---   The entropy must be at least 128 bits long, at most 256 bits long,
---   and its length must be a multiple of 32 bits. Providing invalid
---   entropy will result in an 'ErrorCall' exception.
+--   The entropy must be at least 128 bits long and at most 256 bits
+--   long. Providing invalid entropy will result in an 'ErrorCall'
+--   exception.
 --
 --   >>> import qualified System.Entropy as E
 --   >>> trop <- E.getEntropy 16
@@ -204,7 +204,7 @@ seed_unsafe mnem pass
 --   False
 valid
   :: T.Text -- ^ mnemonic
-  -> Bool   -- ^ true if valid
+  -> Bool   -- ^ 'True' if valid
 valid mnem =
        length ws `elem` [12, 15, 18, 21, 24]
     && all M.isJust (fmap (\word -> F.find (== word) wlist) ws)
@@ -225,7 +225,7 @@ valid mnem =
 _valid
   :: Wordlist
   -> T.Text   -- ^ mnemonic
-  -> Bool     -- ^ true if valid
+  -> Bool     -- ^ 'True' if valid
 _valid (Wordlist wlist) mnem =
        length ws `elem` [12, 15, 18, 21, 24]
     && all M.isJust (fmap (\word -> F.find (== word) wlist) ws)