bech32

commit 0c0ea70378b00100f5c89c85ff857d4df779d484
parent 56697a761114f4bb7209af45189cfb70b5bbd957
Author: Jared Tobin <jared@jtobin.io>
Date:   Fri,  3 Jan 2025 20:51:43 -0330

lib: comments

Diffstat:
M
lib/Data/ByteString/Bech32.hs
 | 
2
+-
M
lib/Data/ByteString/Bech32m.hs
 | 
2
+-

2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/Data/ByteString/Bech32.hs b/lib/Data/ByteString/Bech32.hs
@@ -68,7 +68,7 @@ encode hrp (B32.encode -> dat) = do
 --   Nothing
 decode
   :: BS.ByteString                        -- ^ bech23-encoded bytestring
-  -> Maybe (BS.ByteString, BS.ByteString)
+  -> Maybe (BS.ByteString, BS.ByteString) -- ^ (hrp, data less checksum)
 decode bs@(BSI.PS _ _ l) = do
   guard (l <= 90)
   guard (verify bs)
diff --git a/lib/Data/ByteString/Bech32m.hs b/lib/Data/ByteString/Bech32m.hs
@@ -69,7 +69,7 @@ encode hrp (B32.encode -> dat) = do
 --   Nothing
 decode
   :: BS.ByteString                        -- ^ bech23-encoded bytestring
-  -> Maybe (BS.ByteString, BS.ByteString)
+  -> Maybe (BS.ByteString, BS.ByteString) -- ^ (hrp, data less checksum)
 decode bs@(BSI.PS _ _ l) = do
   guard (l <= 90)
   guard (verify bs)