From 9ed666368987a15aa7afade72619c95671c652cf Mon Sep 17 00:00:00 2001 From: Ondrej Sedlacek Date: Wed, 23 Oct 2024 12:15:21 +0200 Subject: [PATCH] Docs: Clarify callback descriptions. --- docs/modules.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/modules.md b/docs/modules.md index 4643741d..5303baca 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -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]]`. @@ -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]]]`.