Add documentation and example for write-module-hook #714
Conversation
Also fix some typos and minor issues
boegel
changed the title
| * 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) will then be appended to the contents of the module file. |
There was a problem hiding this comment.
@boegel You changed this sentence and introduced a mistake: The contents will be written to the module file. NOT appended, just as I wrote initially. The whole return value will be used and written directly, so this is misleading
Or what did you mean by "appended" here?
There was a problem hiding this comment.
Oh, and I even checked the code before changing this... Will fix.
There was a problem hiding this comment.
For rerference see https://github.com/easybuilders/easybuild-framework/blob/96977045496d8a5106a54727f6522c92863008e8/easybuild/framework/easyblock.py#L3168-L3170 and https://github.com/easybuilders/easybuild-framework/blob/96977045496d8a5106a54727f6522c92863008e8/easybuild/framework/easyblock.py#L3179
There was a problem hiding this comment.
Fixed in #715, thanks for double checking and catching this!
Also fix some typos and minor issues