jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2025-01-08 15:08:46 +03:00
Code Issues Projects Releases Wiki Activity

docs: more RST fixes

Browse Source
This commit is contained in:
Jonathan Daugherty 2015-07-23 18:05:03 -07:00
parent 6799a15cb1
commit 9388e6e44a
1 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/index.rst
View File

@ -16,10 +16,10 @@ abstraction and combinators for expressing user interface layouts.
The process of writing an application using ``brick`` entails writing The process of writing an application using ``brick`` entails writing
two important functions: two important functions:
* A *drawing function* that turns your application state into a - A *drawing function* that turns your application state into a
specification of how your interface should look, and specification of how your interface should look, and
* An *event handler* that takes your application state and an input - An *event handler* that takes your application state and an input
event and decides whether to change the state or quit the program. event and decides whether to change the state or quit the program.
We write drawing functions in ``brick`` using an extensive set of We write drawing functions in ``brick`` using an extensive set of
primitives and combinators to place text on the screen, set its primitives and combinators to place text on the screen, set its
@ -64,21 +64,20 @@ API Conventions
documentation and as you explore the library source and write your own documentation and as you explore the library source and write your own
programs. programs.
* Use of `lens`_: ``brick`` uses ``lens`` functions internally and also - Use of `lens`_: ``brick`` uses ``lens`` functions internally and also
exposes lenses for many types in the library. However, if you exposes lenses for many types in the library. However, if you prefer
prefer not to use the ``lens`` interface in your program, all not to use the ``lens`` interface in your program, all ``lens``
``lens`` interfaces have non-`lens` equivalents exported by the interfaces have non-`lens` equivalents exported by the same module. In
same module. In general, the "``L``" suffix on something tells general, the "``L``" suffix on something tells you it is a ``lens``;
you it is a ``lens``; the name without the "``L``" suffix is the the name without the "``L``" suffix is the non-`lens` version. You can
non-`lens` version. You can get by without using ``brick``'s ``lens`` get by without using ``brick``'s ``lens`` interface but your life will
interface but your life will probably be much more pleasant once your probably be much more pleasant once your application state becomes
application state becomes sufficiently complex (see `appHandleEvent: sufficiently complex (see `appHandleEvent: Handling Events`_).
Handling Events`_). - Attribute names: some modules export attribute names (see `How
* Attribute names: some modules export attribute names (see `How Attributes Work`_) associated with user interface elements. These tend
Attributes Work`_) associated with user interface elements. to end in an "``Attr``" suffix (e.g. ``borderAttr``). In addition,
These tend to end in an "``Attr``" suffix (e.g. ``borderAttr``). hierarchical relationships between attributes are documented in
In addition, hierarchical relationships between attributes are Haddock documentation.
documented in Haddock documentation.
The App Type The App Type
============ ============