on master help sign in
Fix doc for iter.

--HG-- extra : convert_revision : bc6d86177ae21b8a26a558d4d87a492c36bdbe1f

commit9c7690f4f8145f8f3195a27281939807f2233a31 authorBryan O'Sullivan <bos@serpentine.com> dateThu 12 Feb 2009, 08:40 (18 years ago) parent4efa78e
1 file changed+3−3
Data/Text/Unsafe.hs+3−3
Data/Text/Unsafe.hs+3−3
@@ -43,9 +43,9 @@ unsafeTail t@(Text arr off len) =
4343 where d = iter_ t 0
4444{-# INLINE unsafeTail #-}
4545
46−-- | /O(1)/ Iterate one step through a UTF-16 array, returning the
47−-- current character and the delta to add to give the next offset to
48−-- iterate at.
46+-- | /O(1)/ Iterate one step forwards through a UTF-16 array,
47+-- returning the current character and the delta to add to give the
48+-- next offset to iterate at.
4949iter :: Text -> Int -> (Char,Int)
5050iter (Text arr off len) i
5151 | m < 0xD800 || m > 0xDBFF = (unsafeChr m, 1)