Add documentation for lenient decoding

2 files changed, 8 insertions, 3 deletions

diff --git a/src/Data/ByteString/Base32.hs b/src/Data/ByteString/Base32.hs
index 0568c54..5f0eb64 100644
--- a/src/Data/ByteString/Base32.hs
+++ b/src/Data/ByteString/Base32.hs
@@ -55,10 +55,12 @@ decW5 !x
 decTable :: ByteString
 decTable = BS.pack $ L.map decW5 [minBound .. maxBound]
 
--- | Decode a base32 encoded bytestring.
+-- | Decode a base32 encoded bytestring. This functions is
+-- case-insensitive and do not requires correct padding.
 decode :: Base32 -> ByteString
 decode = pack5 decTable
 
--- | Case-insensitive counterpart of the 'decode'.
+-- | The same as 'decode' but with additional leniency: decodeLenient
+-- will skip non-alphabet characters.
 decodeLenient :: Base32 -> ByteString
 decodeLenient = pack5Lenient decTable
\ No newline at end of file
diff --git a/src/Data/ByteString/Base32/Hex.hs b/src/Data/ByteString/Base32/Hex.hs
index db5fe1b..3a70055 100644
--- a/src/Data/ByteString/Base32/Hex.hs
+++ b/src/Data/ByteString/Base32/Hex.hs
@@ -53,9 +53,12 @@ decW5 !x
 decTable :: DecTable
 decTable = BS.pack $ L.map decW5 [minBound .. maxBound]
 
--- | Decode a base32hex encoded bytestring.
+-- | Decode a base32hex encoded bytestring. This functions is
+-- case-insensitive and do not requires correct padding.
 decode :: Base32Hex -> ByteString
 decode = pack5 decTable
 
+-- | The same as 'decode' but with additional leniency: decodeLenient
+-- will skip non-alphabet characters.
 decodeLenient :: Base32Hex -> ByteString
 decodeLenient = pack5Lenient decTable
\ No newline at end of file