1 files changed, 7 insertions(+), 0 deletions(-)

M 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.