Skip to content

Commit

Permalink
Update documentation index.
Browse files Browse the repository at this point in the history
  • Loading branch information
benmoran56 committed Oct 1, 2022
1 parent eec6fd4 commit 8e68909
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ Processors

Components
----------
**esper** does not define any specific
Component base class. Instead, normal
Python classes are used as Components.
**esper** does not define any specific Component base class
to inherit from. Instead, a normal Python class can be used.
Also, while it's not required, the the `@dataclass` decorator
from the `dataclasses` module can be useful to help write
compact Component classes.


The World Class
Expand All @@ -21,12 +23,9 @@ The World Class

Events
------
**esper** provides basic functionality for
dispatching and handling events. Minimal
error checking is done. It's left up to the
user to ensure that events and handlers are
dispatched and received with the correct
number of arguments.
For convenience, **esper** includes functionality for
dispatching and handling events. This is limited in scope,
but should be robust enough for most general use cases.

.. autofunction:: esper.dispatch_event
.. autofunction:: esper.set_handler
Expand Down

0 comments on commit 8e68909

Please sign in to comment.