installUnicodeWidthTable: add a more obvious "do not use" comment

This commit is contained in:
Jonathan Daugherty 2020-03-05 14:33:20 -08:00
parent 5327c94b12
commit 4e21a740e8

View File

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