Skip to content

Fix description of init hook function arguments #14457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix description of init hook function arguments #14457

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions content/developer/reference/backend/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,18 +135,15 @@ Available manifest fields are:
Person or entity in charge of the maintenance of this module, by default
it is assumed that the author is the maintainer.
``{pre_init, post_init, uninstall}_hook`` (``str``)
Hooks for module installation/uninstallation, their value should be a
Hooks for module installation/uninstallation. Their value should be a
string representing the name of a function defined inside the module's
``__init__.py``.
``__init__.py``. The function should take an environment as its only argument.

``pre_init_hook`` takes a cursor as its only argument, this function is
executed prior to the module's installation.
``pre_init_hook`` is executed prior to the module's installation.

``post_init_hook`` takes a cursor and a registry as its arguments, this
function is executed right after the module's installation.
``post_init_hook`` is executed right after the module's installation.

``uninstall_hook`` takes a cursor and a registry as its arguments, this
function is executed after the module's uninstallation.
``uninstall_hook`` is executed after the module's uninstallation.

These hooks should only be used when setup/cleanup required for this module
is either extremely difficult or impossible through the api.
Expand Down