Skip to content

Commit

Permalink
docs: typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
benmoran56 committed May 28, 2024
1 parent 599174b commit 2aecdad
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Processors
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. You can even use ``namedtuple``s
for limited cases where a Component does not need to be modified.
to inherit from. Any valid Python class can be used. For more
compact definitions, the ``@dataclass`` decorator from the
``dataclasses`` is quite useful. You can even use a
``namedtuple`` instead of a class, for limited cases where a
Component does not need to be modified.
Some examples of valid Components::

class Velocity:
Expand All @@ -37,7 +37,6 @@ The World context
-----------------

.. autofunction:: esper.switch_world
.. autoattribute:: esper.current_world
.. autofunction:: esper.delete_world
.. autofunction:: esper.list_worlds
.. autofunction:: esper.create_entity
Expand All @@ -62,6 +61,11 @@ The World context
.. autofunction:: esper.clear_cache
.. autofunction:: esper.clear_dead_entities

Attributes
----------
.. autoattribute:: esper.current_world
.. autoattribute:: esper.process_times

Events
------
For convenience, **esper** includes functionality for
Expand Down

0 comments on commit 2aecdad

Please sign in to comment.