Skip to content

Commit

Permalink
docfix
Browse files Browse the repository at this point in the history
  • Loading branch information
jquast committed Oct 31, 2023
1 parent 030d195 commit f92018b
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions blessed/terminal.py
Original file line number Diff line number Diff line change
Expand Up @@ -1440,15 +1440,11 @@ def inkey(self, timeout=None, esc_delay=DEFAULT_ESCDELAY):
escape such as *KEY_LEFT*, sequence ``'\x1b[D'``], before returning a
:class:`~.Keystroke` instance for ``KEY_ESCAPE``.
Users may also override this for all blessed and curses applications
with environment value of ESCDELAY_ as an integer in milliseconds.
You may also override user preference as an argument to this function,
as the delay value is in seconds.
It could be set to low value such as 10, modern pipelines typically
transmit a keyboard input sequence without framing and this can often
be safely set at very low values!
Users may override the default value of ``esc_delay`` in seconds,
using environment value of ``ESCDELAY`` as milliseconds, see
`ncurses(3)`_ section labeled *ESCDELAY* for details. Setting
the value as an argument to this function will override any
such preference.
:rtype: :class:`~.Keystroke`.
:returns: :class:`~.Keystroke`, which may be empty (``u''``) if
``timeout`` is specified and keystroke is not received.
Expand All @@ -1463,6 +1459,8 @@ def inkey(self, timeout=None, esc_delay=DEFAULT_ESCDELAY):
<https://docs.microsoft.com/en-us/windows/win32/api/timeapi/nf-timeapi-timebeginperiod>`_.
Decreasing the time resolution will reduce this to 10 ms, while increasing it, which
is rarely done, will have a perceptable impact on the behavior.
_`ncurses(3)`: https://www.man7.org/linux/man-pages/man3/ncurses.3x.html
"""
resolve = functools.partial(resolve_sequence,
mapper=self._keymap,
Expand Down

0 comments on commit f92018b

Please sign in to comment.