6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-16 18:15:09 +00:00
tutor/changelog.d/20230106_190620_regis_hooks_api.md
Kyle McCormick 86bf655842 docs: fix typos in hooks changelog entry
* Remove redundant changelog line
* The change should NOT affect most developers ;)
2023-01-31 18:47:30 +01:00

913 B

  • 💥[Feature] Simplify the hooks API. The modules tutor.hooks.actions, tutor.hooks.filters, and tutor.hooks.contexts are no longer part of the API. This change should not affect most developers, who only use the Actions and Filters classes (notice the plural) from tutor.hooks. (by @regisb)
    • Instead of tutor.hooks.actions.get("some:action"), use tutor.hooks.Actions.SOME_ACTION.
    • Instead of tutor.hooks.filters.get("some:filter"), use tutor.hooks.Filters.SOME_FILTER.
    • Instead of tutor.hooks.actions.add("some:action"), use tutor.hooks.Actions.SOME_ACTION.add(). The same applies to the do method.
    • Instead of tutor.hooks.filters.add("some:filter"), use tutor.hooks.Filters.SOME_FILTER.add(). The same applies to the add_item, add_items, apply, and iterate methods.
    • Instead of tutor.hooks.contexts.enter, use tutor.core.hooks.contexts.enter.