commentary update

src/Graphics/Vty/Input.hs

@@ -19,14 +19,10 @@
 --
 -- vty assumes 7 bit mode. Which is the default AFAIK.
 --
--- 1. ESC individually: ESC byte, no bytes for control-seq-period,
--- no bytes for meta-combo-period.
+-- 1. ESC individually: ESC byte, no bytes for 'singleEscPeriod'.
 --
--- 2. control keys that contain ESC in their byte sequence: ESC byte, bytes read within
--- control-seq-period are part of the sequence. Up until the next valid input block.
---
--- 3. ESC used as meta in a key combination: ESC byte, no other bytes read within
--- control-seq-period. Bytes up until next valid input block are the input events plus meta.
+-- 2. control keys that contain ESC in their byte sequence: ESC byte. Bytes read within
+-- 'singleEscPeriod' are part of the sequence up until the next valid input block.
 --
 -- If the current runtime is the threaded runtime then the terminal's VMIN and VTIME parameters can
 -- be applied to implement the above rules.
@@ -66,6 +62,9 @@ inputForCurrentTerminal config = do
 
 -- | Set up the terminal attached to the given Fd for input.  Returns a 'Input'.
 --
+-- The table used to determine the 'Events' to produce for the input bytes comes from
+-- 'classifyTableForTerm'.
+--
 -- The terminal is modified as follows:
 --
 -- * IXON disabled

test/interactive_terminal_test.hs

@@ -66,11 +66,10 @@ All the tests assume the following about the terminal display:
 Thanks for the help! :-D
 To exit the test early enter "q" anytime at the following menu screen.
 
-If any test failed then please post an issue to
+If any test fails then please post an issue to
     https://github.com/coreyoconnor/vty/issues
-with the test_results.list file pasted into the issue. The issue summary can
-mention the specific tests that failed or just say "interactive terminal test
-failure".
+with the test_results.list file pasted into the issue. A suitable summary is:
+"interactive terminal test failure".
 |]
     waitForReturn
     results <- doTestMenu 1