X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/puzzles/blobdiff_plain/f92acd1ac36fa42e599c75fbc825b92e6c0cb1af..8e402806b508e8f8a922b280a9c55014babe1bff:/devel.but

diff --git a/devel.but b/devel.but
index e481ec6..ea23d52 100644
--- a/devel.but
+++ b/devel.but
@@ -2671,6 +2671,11 @@ Calling this function is very likely to result in calls back to the
 front end's drawing API and/or \cw{activate_timer()}
 (\k{frontend-activate-timer}).
 
+The return value from \cw{midend_process_key()} is non-zero, unless
+the effect of the keypress was to request termination of the
+program. A front end should shut down the puzzle in response to a
+zero return.
+
 \H{midend-colours} \cw{midend_colours()}
 
 \c float *midend_colours(midend *me, int *ncolours);