@@ -33,6 +33,12 @@ tableSize = 0x110000
3333-- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable' and
3434-- 'Graphics.Vty.UnicodeWidthTable.IO.readUnicodeWidthTable'.
3535--
36+-- ALERT! This function is probably not what you want to use because
37+-- it is automatically called by 'Graphics.Vty.mkVty'. You will only
38+-- ever need to call this function if you want to use functions
39+-- in 'Graphics.Text.Width' without controlling the terminal with
40+-- 'Graphics.Vty.mkVty'.
41+--
3642-- This affects the behavior of the 'Graphics.Vty.Image.wcwidth'
3743-- function and functions that call it. It does so by
3844-- changing global state available to the C implementation