Migrate mkVty docs on table loading to Config

This commit is contained in:
Jonathan Daugherty 2020-03-05 14:20:14 -08:00
parent e8e3fa3ba8
commit b54772ac1d
2 changed files with 10 additions and 12 deletions

View File

@ -112,15 +112,6 @@ data Vty =
-- precedence. See "Graphics.Vty.Config".
--
-- For most applications @mkVty defaultConfig@ is sufficient.
--
-- If the configuration's 'allowCustomUnicodeWidthTables' is set
-- to 'Nothing' or 'Just True', this will use the current value of
-- 'TERM' and the configuation's width table settings to attempt to
-- load a custom unicode character width table if one has not already
-- been loaded in this process. If the load is attempted and fails,
-- information about the failure will be logged to the debug log if the
-- configuration specifies one. If no custom table is loaded (or if a
-- load fails), the built-in character width table will be used.
mkVty :: Config -> IO Vty
mkVty appConfig = do
config <- (<> appConfig) <$> userConfig

View File

@ -178,9 +178,16 @@ data Config =
, termWidthMaps :: [(String, FilePath)]
-- ^ Terminal width map files.
, allowCustomUnicodeWidthTables :: Maybe Bool
-- ^ Whether to permit custom Unicode width table loading.
-- 'Just False' indicates that table loading should not be
-- performed. Other values permit table loading.
-- ^ Whether to permit custom Unicode width table loading by
-- 'Graphics.Vty.mkVty'. @'Just' 'False'@ indicates that
-- table loading should not be performed. Other values permit
-- table loading.
--
-- If a table load is attempted and fails, information
-- about the failure will be logged to the debug log if the
-- configuration specifies one. If no custom table is loaded
-- (or if a load fails), the built-in character width table
-- will be used.
}
deriving (Show, Eq)