[commit: base] master: Fix documentation for withCWStringLen (#5396) (a57369f)

[Simon Marlow]

Repository : ssh://darcs.haskell.org//srv/darcs/packages/base

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/a57369f54bd25a1de5d477f3c363b3bafd17d168

>---------------------------------------------------------------

commit a57369f54bd25a1de5d477f3c363b3bafd17d168
Author: Simon Marlow <marlowsd at gmail.com>
Date:   Thu Aug 25 10:41:43 2011 +0100

    Fix documentation for withCWStringLen (#5396)

>---------------------------------------------------------------

 Foreign/C/String.hs |    7 +++----
 1 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/Foreign/C/String.hs b/Foreign/C/String.hs
index f369916..09dd27a 100644
--- a/Foreign/C/String.hs
+++ b/Foreign/C/String.hs
@@ -484,10 +484,9 @@ newCWStringLen str  = newArrayLen (charsToCWchars str)
 withCWString :: String -> (CWString -> IO a) -> IO a
 withCWString  = withArray0 wNUL . charsToCWchars
 
--- | Marshal a Haskell string into a NUL terminated C wide string using
--- temporary storage.

>---------------------------------------------------------------

--- * the Haskell string may /not/ contain any NUL characters
+-- | Marshal a Haskell string into a C wide string (i.e. wide
+-- character array) in temporary storage, with explicit length
+-- information.
 --
 -- * the memory is freed when the subcomputation terminates (either
 --   normally or via an exception), so the pointer to the temporary