jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-12-27 07:53:44 +03:00
Code Issues Projects Releases Wiki Activity

guide: wording

Browse Source
This commit is contained in:
Jonathan Daugherty 2022-08-05 15:17:40 -07:00
parent 84703cb419
commit c501330d79
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/guide.rst
View File

@ -1635,11 +1635,12 @@ The customizable keybindings API provides:
* ``Brick.Keybindings.KeyDispatcher``: specifying handlers and
dispatching incoming key events to them.
Brick provides a complete working example of the custom keybinding API
in ``programs/CustomKeybindingDemo.hs``. This section of the User Guide
describes the API at a high level. More detailed documentation on how to
use the API, including a step-by-step process for using it, can be found
in the module documentation for ``Brick.Keybindings.KeyDispatcher``.
This section of the User Guide describes the API at a high level,
but Brick also provides a complete working example of the custom
keybinding API in ``programs/CustomKeybindingDemo.hs`` and
provides detailed documentation on how to use the API, including a
step-by-step process for using it, in the module documentation for
``Brick.Keybindings.KeyDispatcher``.
The following table compares Brick application design decisions and
runtime behaviors in a typical application compared to one that uses the