fixup! Expose incremental UTF8 decoding APIs

Author: adithyaov

core/src/Streamly/Internal/Unicode/Stream.hs

@@ -190,25 +190,21 @@ encodeLatin1Lax = encodeLatin1
 -- UTF-8 decoding
 -------------------------------------------------------------------------------
 
--- | CodePoint represents a specific character in the Unicode standard.  The
--- code point is a numerical value assigned to each character, and UTF-8
--- encoding uses a variable number of bytes to represent different code points.
+-- | CodePoint represents a specific character in the Unicode standard.
 --
--- Calculate the code point value: Depending on the type of the leading byte,
--- extract the significant bits from each byte of the sequence and combine them
--- to form the complete code point value. The specific bit manipulations will
--- differ based on the number of bytes used.
+-- It is meant to be used with the resumable decoding APIs such as
+-- 'resumeDecodeUtf8Either'.
+--
+-- We return the 'CodePoint' and the 'DecodeState' in 'DecodeError'.
 type CodePoint = Int
 
 -- | DecodeState refers to the number of bytes remaining to complete the current
--- UTF-8 character decoding. For ASCII characters (code points 0 to 127), no
--- decoding state is necessary because they are represented by a single byte.
--- Therefore, the decoding state for ASCII characters can be considered as 0.
+-- UTF-8 character decoding.
+--
+-- It is meant to be used with the resumable decoding APIs such as
+-- 'resumeDecodeUtf8Either'.
 --
--- For multi-byte characters, the decoding state indicates the number of bytes
--- remaining to complete the character. It is usually initialized to a non-zero
--- value corresponding to the number of bytes in the multi-byte character, e.g
--- DecodeState will be 1 for 2-bytes char.
+-- We return the 'CodePoint' and the 'DecodeState' in 'DecodeError'.
 type DecodeState = Word8
 
 -- We can divide the errors in three general categories: