on master help sign in
Vty: improve docstring
commit135247643963fcfd7471798bcfb537a7c6b4361c authorJonathan Daugherty <cygnus@foobox.com> dateTue 3 Mar 2020, 09:38 (7 years ago) parenta3c009b
1 file changed+3−2
src/Graphics/Vty.hs+3−2
src/Graphics/Vty.hs+3−2
@@ -68,7 +68,7 @@ import Data.Semigroup ((<>))
6868--
6969-- The use of Vty typically follows this process:
7070--
71−-- 1. Initialize vty
71+-- 1. Initialize vty with 'mkVty' (this takes control of the terminal).
7272--
7373-- 2. Use 'update' to display a picture.
7474--
@@ -76,7 +76,8 @@ import Data.Semigroup ((<>))
7676--
7777-- 4. Depending on the event, go to 2 or 5.
7878--
79−-- 5. Shutdown vty.
79+-- 5. Shutdown vty and restore the terminal state with 'shutdown'. At
80+-- this point the 'Vty' handle cannot be used again.
8081--
8182-- Operations on Vty handles are not thread-safe.
8283data Vty =