on master help sign in
supportsItalics, supportsStrikethrough: documentation
commitef6b73d71bf91a831605026ece55add712db5e37 authorJonathan Daugherty <cygnus@foobox.com> dateTue 13 Oct 2020, 08:57 (6 years ago) parentbcbf7fa
1 file changed+12
src/Graphics/Vty/Output/Interface.hs+12
src/Graphics/Vty/Output/Interface.hs+12
@@ -102,8 +102,20 @@ data Output = Output
102102 -- | Returns whether the terminal has an audio bell feature.
103103 , supportsBell :: IO Bool
104104 -- | Returns whether the terminal supports italicized text.
105+ --
106+ -- This is terminal-dependent and should make a best effort to
107+ -- determine whether this feature is supported, but even if the
108+ -- terminal advertises support (e.g. via terminfo) that might not
109+ -- be a reliable indicator of whether the feature will work as
110+ -- desired.
105111 , supportsItalics :: IO Bool
106112 -- | Returns whether the terminal supports strikethrough text.
113+ --
114+ -- This is terminal-dependent and should make a best effort to
115+ -- determine whether this feature is supported, but even if the
116+ -- terminal advertises support (e.g. via terminfo) that might not
117+ -- be a reliable indicator of whether the feature will work as
118+ -- desired.
107119 , supportsStrikethrough :: IO Bool
108120 }
109121