mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-06-07 08:30:48 +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
11 lines
393 B
ReStructuredText
11 lines
393 B
ReStructuredText
.. _contexts:
|
|
|
|
========
|
|
Contexts
|
|
========
|
|
|
|
Contexts are a feature of the hook-based extension system in Tutor, which allows us to keep track of which components of the code created which callbacks. Contexts are very much an internal concept that most plugin developers should not have to worry about.
|
|
|
|
.. autoclass:: tutor.core.hooks.Context
|
|
.. autofunction:: tutor.core.hooks.contexts::enter
|