mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-10-01 21:59:02 +00:00
71ed7a8618
The hooks API had several issues which are summarized in this comment: https://github.com/openedx/wg-developer-experience/issues/125#issuecomment-1313553526 1. "consts" was a bad name 2. "hooks.filters" and "hooks.Filters" could easily be confused 3. docs made it difficult to understand that plugin developers should use the catalog To address these issues, we: 1. move "consts.py" to "catalog.py" 2. Remove "hooks.actions", "hooks.filters", "hooks.contexts" from the API. 3. re-organize the docs and give better usage examples in the catalog. This change is a partial fix for https://github.com/openedx/wg-developer-experience/issues/125
18 lines
717 B
ReStructuredText
18 lines
717 B
ReStructuredText
.. _actions:
|
|
|
|
=======
|
|
Actions
|
|
=======
|
|
|
|
Actions are one of the two types of hooks (the other being :ref:`filters`) that can be used to extend Tutor. Each action represents an event that can occur during the application life cycle. Each action has a name, and callback functions can be attached to it. When an action is triggered, these callback functions are called in sequence. Each callback function can trigger side effects, independently from one another.
|
|
|
|
.. autoclass:: tutor.core.hooks.Action
|
|
:members:
|
|
|
|
.. autoclass:: tutor.core.hooks.ActionTemplate
|
|
:members:
|
|
|
|
.. The following are only to ensure that the docs build without warnings
|
|
.. class:: tutor.core.hooks.actions.T
|
|
.. class:: tutor.types.Config
|