From 68bd351026d562f4784f6095bbb3c8e8dae46009 Mon Sep 17 00:00:00 2001 From: Sam Truzjan Date: Fri, 29 Nov 2013 11:20:23 +0400 Subject: Improve documentation a bit --- src/Data/ByteString/Base32.hs | 4 ++-- src/Data/ByteString/Base32/Hex.hs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'src/Data') diff --git a/src/Data/ByteString/Base32.hs b/src/Data/ByteString/Base32.hs index 5f0eb64..efc5951 100644 --- a/src/Data/ByteString/Base32.hs +++ b/src/Data/ByteString/Base32.hs @@ -37,7 +37,7 @@ encW5 !x encTable :: EncTable encTable = BS.pack $ L.map encW5 [0..31] --- | Encode a bytestring into base32 form. +-- | Encode an arbitrary bytestring into (upper case) base32 form. encode :: ByteString -> Base32 encode = unpack5 encTable @@ -56,7 +56,7 @@ decTable :: ByteString decTable = BS.pack $ L.map decW5 [minBound .. maxBound] -- | Decode a base32 encoded bytestring. This functions is --- case-insensitive and do not requires correct padding. +-- case-insensitive and do not require correct padding. decode :: Base32 -> ByteString decode = pack5 decTable diff --git a/src/Data/ByteString/Base32/Hex.hs b/src/Data/ByteString/Base32/Hex.hs index 3a70055..c38c2da 100644 --- a/src/Data/ByteString/Base32/Hex.hs +++ b/src/Data/ByteString/Base32/Hex.hs @@ -36,7 +36,7 @@ encW5 !x encTable :: EncTable encTable = BS.pack $ L.map encW5 [0..31] --- | Encode a bytestring into base32hex form. +-- | Encode an arbitrary bytestring into (upper case) base32hex form. encode :: ByteString -> Base32Hex encode = unpack5 encTable -- cgit v1.2.3