Skip to content

Commit

Permalink
Docs: Clarify callback descriptions.
Browse files Browse the repository at this point in the history
  • Loading branch information
xsedla1o committed Oct 23, 2024
1 parent 98c1198 commit 9ed6663
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ registrar.register_allow_entity_creation_hook(

Receives eid and Task, may return new DataPointTasks.

The callback is registered using the
Callbacks which are called once when an entity is created are registered using the
[`register_on_entity_creation_hook`][dp3.common.callback_registrar.CallbackRegistrar.register_on_entity_creation_hook] method.
Required signature is `Callable[[str, DataPointTask], list[DataPointTask]]`.

Expand Down Expand Up @@ -240,7 +240,7 @@ registrar.register_on_entity_creation_hook(

#### Attribute hooks

Callbacks are registered using the
Callbacks that are called on every incoming datapoint of an attribute are registered using the
[`register_on_new_attr_hook`][dp3.common.callback_registrar.CallbackRegistrar.register_on_new_attr_hook] method.
The callback allways receives eid, attribute and Task, and may return new DataPointTasks.
The required signature is `Callable[[str, DataPointBase], Union[None, list[DataPointTask]]]`.
Expand Down

0 comments on commit 9ed6663

Please sign in to comment.