on master help sign in
Vty: improve docstring
1352476Jonathan Daugherty
src/Graphics/Vty.hs+3−2
@@ -68,7 +68,7 @@ import Data.Semigroup ((<>))
68--
68--
69-- The use of Vty typically follows this process:
69-- The use of Vty typically follows this process:
70--
70--
71−-- 1. Initialize vty
71+-- 1. Initialize vty with 'mkVty' (this takes control of the terminal).
72--
72--
73-- 2. Use 'update' to display a picture.
73-- 2. Use 'update' to display a picture.
74--
74--
@@ -76,7 +76,8 @@ import Data.Semigroup ((<>))
76--
76--
77-- 4. Depending on the event, go to 2 or 5.
77-- 4. Depending on the event, go to 2 or 5.
78--
78--
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.
80--
81--
81-- Operations on Vty handles are not thread-safe.
82-- Operations on Vty handles are not thread-safe.
82data Vty =
83data Vty =