diff options
| author | Jonathan Slenders <jonathan@slenders.be> | 2018-05-20 23:35:41 +0200 |
|---|---|---|
| committer | Jonathan Slenders <jonathan@slenders.be> | 2018-05-20 23:35:41 +0200 |
| commit | 0f60aa594aaad20816181c0a6298e8a9946bb551 (patch) | |
| tree | 9c2a1e7b0da9515bac0668bae47fb630d00dceaf | |
| parent | 80f44e6f589cfeb0120a94007c0c6493c41400c3 (diff) | |
A few small doc improments.
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/pages/advanced_topics/key_bindings.rst | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py index 6bc45f61..30b26d69 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,7 +44,7 @@ master_doc = 'index' # General information about the project. project = u'prompt_toolkit' -copyright = u'2014-2017, Jonathan Slenders' +copyright = u'2014-2018, Jonathan Slenders' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/pages/advanced_topics/key_bindings.rst b/docs/pages/advanced_topics/key_bindings.rst index aa9ec1b0..a6e791b3 100644 --- a/docs/pages/advanced_topics/key_bindings.rst +++ b/docs/pages/advanced_topics/key_bindings.rst @@ -159,14 +159,14 @@ Timeouts There are two timeout settings that effect the handling of keys. -- ``Application.input_timeout``: Like Vim's `ttimeoutlen` option. +- ``Application.ttimeoutlen``: Like Vim's `ttimeoutlen` option. When to flush the input (For flushing escape keys.) This is important on terminals that use vt100 input. We can't distinguish the escape key from for instance the left-arrow key, if we don't know what follows after "\x1b". This little timer will consider "\x1b" to be escape if nothing did follow in this time span. This seems to work like the `ttimeoutlen` option in Vim. -- ``KeyProcessor.timeout``: like Vim's `timeoutlen` option. +- ``KeyProcessor.timeoutlen``: like Vim's `timeoutlen` option. This can be `None` or a float. For instance, suppose that we have a key binding AB and a second key binding A. If the uses presses A and then waits, we don't handle this binding yet (unless it was marked 'eager'), because we |