Graphics.Text.Width: add module docs

This commit is contained in:
Jonathan Daugherty 2020-03-05 14:31:38 -08:00
parent 3d8dbf6ffd
commit 5327c94b12

View File

@ -1,6 +1,15 @@
-- Copyright 2009 Corey O'Connor
{-# OPTIONS_GHC -D_XOPEN_SOURCE #-}
{-# LANGUAGE ForeignFunctionInterface #-}
-- | This module provides functions to measure the terminal column width
-- of characters and strings.
--
-- The functions provided in this module all ultimately make calls to
-- the C implementation in @cbits/mk_wcwidth.c@. That code manages some
-- global state that carries a table of Unicode character widths. For
-- more details, see 'Graphics.Vty.UnicodeWidthTable.Install', the C
-- code, and the "Multi-Column Character Support" section of the project
-- @README@.
module Graphics.Text.Width
( wcwidth
, wcswidth