projects
/
ghc-base.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
a8927d2
)
Document invariants on mkText{Decoder,Encoder}
author
Max Bolingbroke
<batterseapower@hotmail.com>
Mon, 4 Apr 2011 13:45:13 +0000
(14:45 +0100)
committer
Max Bolingbroke
<batterseapower@hotmail.com>
Mon, 4 Apr 2011 13:45:13 +0000
(14:45 +0100)
GHC/IO/Encoding/Types.hs
patch
|
blob
|
history
diff --git
a/GHC/IO/Encoding/Types.hs
b/GHC/IO/Encoding/Types.hs
index
caffa24
..
ac9147a
100644
(file)
--- a/
GHC/IO/Encoding/Types.hs
+++ b/
GHC/IO/Encoding/Types.hs
@@
-90,8
+90,12
@@
data TextEncoding
textEncodingName :: String,
-- ^ a string that can be passed to 'mkTextEncoding' to
-- create an equivalent 'TextEncoding'.
textEncodingName :: String,
-- ^ a string that can be passed to 'mkTextEncoding' to
-- create an equivalent 'TextEncoding'.
- mkTextDecoder :: IO (TextDecoder dstate),
- mkTextEncoder :: IO (TextEncoder estate)
+ mkTextDecoder :: IO (TextDecoder dstate),
+ -- ^ Creates a means of decoding bytes into characters: the result must not
+ -- be shared between several byte sequences or simultaneously across threads
+ mkTextEncoder :: IO (TextEncoder estate)
+ -- ^ Creates a means of encode characters into bytes: the result must not
+ -- be shared between several character sequences or simultaneously across threads
}
instance Show TextEncoding where
}
instance Show TextEncoding where