From 8f60687f3d75bb0212e4e4e563fe833b9a03ab5f Mon Sep 17 00:00:00 2001 From: Asa <59259908+AcerP-py@users.noreply.github.com> Date: Thu, 12 Dec 2024 09:51:06 -0500 Subject: [PATCH] Add documentation. --- docs/source/170_hooks.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/170_hooks.rst b/docs/source/170_hooks.rst index 69fdf99c9..ed99df257 100644 --- a/docs/source/170_hooks.rst +++ b/docs/source/170_hooks.rst @@ -177,6 +177,13 @@ used in the Lmod program. 1 output. The table passed in contains the whatis category and the property table. See *rt/uitSitePkg/mf/site_scripts/SitePackage.lua* for a complete example. + +**add_to_module** (table): + (Returns: table) + This hook allows a site to add contents to a module file (e.g. add + ``add_property(...)`` based on the location of the module file). It + provides a table ``{path, name, version, contents}`` as a parameter and + should return an indexed table of strings to add to the module file. Example Hook: msgHook