From 4e21a740e839c20401162a360f0804afbdd2b1b7 Mon Sep 17 00:00:00 2001 From: Jonathan Daugherty Date: Thu, 5 Mar 2020 14:33:20 -0800 Subject: [PATCH] installUnicodeWidthTable: add a more obvious "do not use" comment --- src/Graphics/Vty/UnicodeWidthTable/Install.hs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/Graphics/Vty/UnicodeWidthTable/Install.hs b/src/Graphics/Vty/UnicodeWidthTable/Install.hs index 0eb44e9..36aa7ce 100644 --- a/src/Graphics/Vty/UnicodeWidthTable/Install.hs +++ b/src/Graphics/Vty/UnicodeWidthTable/Install.hs @@ -33,6 +33,12 @@ tableSize = 0x110000 -- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable' and -- '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' -- function and functions that call it. It does so by -- changing global state available to the C implementation