Skip to content

clarify return value of module write hook #716

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

Merged
akesandgren merged 1 commit into from
Jun 14, 2021
Merged

clarify return value of module write hook #716

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
2 changes: 1 addition & 1 deletion docs/Hooks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Do take into account the following:
* the ``EasyBlock`` instance used to perform the installation (usually referred to as ``self``)
* the filepath of the module that will be written
* the module text as a string
The return value of this hook (if any) is used as contents for the module file that will be written.
The return value of this hook, when set, will replace the original text that is then written to the module file.

* for the step hooks, one argument is provided:
the ``EasyBlock`` instance used to perform the installation (usually referred to as ``self``)
Expand Down