on master help sign in
installUnicodeWidthTable: add a more obvious "do not use" comment
4e21a74Jonathan Daugherty
src/Graphics/Vty/UnicodeWidthTable/Install.hs+6
@@ -33,6 +33,12 @@ tableSize = 0x110000
33-- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable' and
33-- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable' and
34-- 'Graphics.Vty.UnicodeWidthTable.IO.readUnicodeWidthTable'.
34-- 'Graphics.Vty.UnicodeWidthTable.IO.readUnicodeWidthTable'.
35--
35--
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+--
36-- This affects the behavior of the 'Graphics.Vty.Image.wcwidth'
42-- This affects the behavior of the 'Graphics.Vty.Image.wcwidth'
37-- function and functions that call it. It does so by
43-- function and functions that call it. It does so by
38-- changing global state available to the C implementation
44-- changing global state available to the C implementation