Dear Maintainer,
The documentation for curses.wrapper says:
Initialize curses and call another callable object, func, which
should be the rest of your curses-using application. If the
application raises an exception, this function will restore the
terminal to a sane state before re-raising the exception and
generating a traceback. The callable object func is then passed the
main window ‘stdscr’ as its first argument, followed by any other
arguments passed to wrapper(). Before calling func, wrapper() turns
on cbreak mode, turns off echo, enables the terminal keypad, and
initializes colors if the terminal has color support. On exit
(whether normally or by exception) it restores cooked mode, turns on
echo, and disables the terminal keypad.
I see several minor problems with this.
1) It doesn't say anything about what's returned on success. The code
has the line 'return func(…)', as expected of a wrapper, which is to
say that it will return whatever the wrapped function returns.
2) There's no code to "generat[e] a traceback". I guess the assumption
is that the re-raised assumption will not be caught, and Python will
do that; but using curses.wrapper that way is merely a suggestion
("func[…] should be the rest"…).
3) It says "re-raising the exception and generating a traceback. The
callable object func is then passed the main window". Despite saying
"then", this is not a linear sequence of events that can happen.
4) "On exit" is unclear about whether it's talking about function exit
or program exit.
- Michael