mirror of
https://github.com/ilyakooo0/vty.git
synced 2024-11-29 08:49:40 +03:00
Migrate mkVty docs on table loading to Config
This commit is contained in:
parent
e8e3fa3ba8
commit
b54772ac1d
@ -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
|
||||
|
@ -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)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user