From b74c9791b783b34ff00a29ab834811ceec594701 Mon Sep 17 00:00:00 2001 From: Jaro Date: Fri, 10 Mar 2023 18:42:40 +0100 Subject: [PATCH] Clarify meaning of Array in Paragraph. --- src/Data/Text/ParagraphLayout/Internal/Paragraph.hs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/Data/Text/ParagraphLayout/Internal/Paragraph.hs b/src/Data/Text/ParagraphLayout/Internal/Paragraph.hs index 80f7db7..34fa076 100644 --- a/src/Data/Text/ParagraphLayout/Internal/Paragraph.hs +++ b/src/Data/Text/ParagraphLayout/Internal/Paragraph.hs @@ -36,6 +36,13 @@ data Paragraph = Paragraph Array -- ^ A byte array containing the whole text to be laid out, in UTF-8. + -- + -- This array will be passed to "Data.Text.Glyphize", which passes it to + -- [@hb_buffer_add_utf8()@] + -- (https://harfbuzz.github.io/harfbuzz-hb-buffer.html#hb-buffer-add-utf8). + -- + -- In the output, `Data.Text.Glyphize.cluster` will be a byte offset of + -- the corresponding input character from this array. Int -- ^ Byte offset of the first span from the start of the byte array. -- 2.30.2