UnicodeWidthTable: documentation improvements

This commit is contained in:
Jonathan Daugherty 2020-03-03 13:07:05 -08:00
parent 1352476439
commit 1545df3207

View File

@ -11,8 +11,9 @@ data WidthTableRange =
WidthTableRange { rangeStart :: Word32
-- ^ The range's starting code point.
, rangeSize :: Word32
-- ^ The number of code points in the range,
-- including the starting code point.
-- ^ The number of code points in the contiguous
-- range, beginning with the starting code point
-- ('rangeStart').
, rangeColumns :: Word8
-- ^ The terminal width, in columns, of all of the
-- characters corresponding to the code points in
@ -20,7 +21,7 @@ data WidthTableRange =
}
deriving (Eq, Show)
-- | A table of Unicode character widths.
-- | A run-length-encoded table of Unicode character widths.
data UnicodeWidthTable =
UnicodeWidthTable { unicodeWidthTableRanges :: [WidthTableRange]
-- ^ The ranges in the table.