diff options
| author | Sam Truzjan <pxqr.sta@gmail.com> | 2013-11-29 11:20:23 +0400 |
|---|---|---|
| committer | Sam Truzjan <pxqr.sta@gmail.com> | 2013-11-29 11:20:23 +0400 |
| commit | 68bd351026d562f4784f6095bbb3c8e8dae46009 (patch) | |
| tree | 0ea4c37eb47bf98c0044b52115e8372603c4b10e /src | |
| parent | 4f859140dfdb80199eb7a92622f5926fcf9ae638 (diff) | |
Improve documentation a bit
Diffstat (limited to 'src')
| -rw-r--r-- | src/Data/ByteString/Base32.hs | 4 | ||||
| -rw-r--r-- | src/Data/ByteString/Base32/Hex.hs | 2 |
2 files changed, 3 insertions, 3 deletions
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 | |||
| 37 | encTable :: EncTable | 37 | encTable :: EncTable |
| 38 | encTable = BS.pack $ L.map encW5 [0..31] | 38 | encTable = BS.pack $ L.map encW5 [0..31] |
| 39 | 39 | ||
| 40 | -- | Encode a bytestring into base32 form. | 40 | -- | Encode an arbitrary bytestring into (upper case) base32 form. |
| 41 | encode :: ByteString -> Base32 | 41 | encode :: ByteString -> Base32 |
| 42 | encode = unpack5 encTable | 42 | encode = unpack5 encTable |
| 43 | 43 | ||
| @@ -56,7 +56,7 @@ decTable :: ByteString | |||
| 56 | decTable = BS.pack $ L.map decW5 [minBound .. maxBound] | 56 | decTable = BS.pack $ L.map decW5 [minBound .. maxBound] |
| 57 | 57 | ||
| 58 | -- | Decode a base32 encoded bytestring. This functions is | 58 | -- | Decode a base32 encoded bytestring. This functions is |
| 59 | -- case-insensitive and do not requires correct padding. | 59 | -- case-insensitive and do not require correct padding. |
| 60 | decode :: Base32 -> ByteString | 60 | decode :: Base32 -> ByteString |
| 61 | decode = pack5 decTable | 61 | decode = pack5 decTable |
| 62 | 62 | ||
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 | |||
| 36 | encTable :: EncTable | 36 | encTable :: EncTable |
| 37 | encTable = BS.pack $ L.map encW5 [0..31] | 37 | encTable = BS.pack $ L.map encW5 [0..31] |
| 38 | 38 | ||
| 39 | -- | Encode a bytestring into base32hex form. | 39 | -- | Encode an arbitrary bytestring into (upper case) base32hex form. |
| 40 | encode :: ByteString -> Base32Hex | 40 | encode :: ByteString -> Base32Hex |
| 41 | encode = unpack5 encTable | 41 | encode = unpack5 encTable |
| 42 | 42 | ||