Skip to content

Commit 3092cd7

Browse files
author
Vasileios Karakasis
committed
Update documentation
1 parent 6be7f7b commit 3092cd7

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

reframe/core/modules.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,6 @@ def load_module(self, name, force=False, collection=False):
222222
conflicting modules currently loaded. If module ``name`` refers to
223223
multiple real modules, all of the target modules will be loaded.
224224
:arg collection: The module is a "module collection" (TMod4 only)
225-
226225
:returns: A list of two-element tuples, where each tuple contains the
227226
module that was loaded and the list of modules that had to be
228227
unloaded first due to conflicts. This list will be normally of
@@ -355,14 +354,17 @@ def searchpath_remove(self, *dirs):
355354
return self._backend.searchpath_remove(*dirs)
356355

357356
def emit_load_commands(self, name, collection=False):
358-
'''Return the appropriate shell command for loading module ``name``.
357+
'''Return the appropriate shell command for loading a module.
358+
359+
Module mappings are not taken into account by this function.
359360
360361
:arg name: The name of the module to load.
361362
:arg collection: The module is a "module collection" (TMod4 only)
362363
:returns: A list of shell commands.
363364
364365
.. versionchanged:: 3.3
365-
The ``collection`` argument was added.
366+
The ``collection`` argument was added and module mappings are no
367+
more taken into account by this function.
366368
367369
'''
368370

@@ -371,10 +373,18 @@ def emit_load_commands(self, name, collection=False):
371373
return [self._backend.emit_load_instr(Module(name, collection))]
372374

373375
def emit_unload_commands(self, name, collection=False):
374-
'''Return the appropriate shell command for unloading module
375-
``name``.
376+
'''Return the appropriate shell command for unloading a module.
377+
378+
Module mappings are not taken into account by this function.
379+
380+
:arg name: The name of the module to unload.
381+
:arg collection: The module is a "module collection" (TMod4 only)
382+
:returns: A list of shell commands.
383+
384+
.. versionchanged:: 3.3
385+
The ``collection`` argument was added and module mappings are no
386+
more taken into account by this function.
376387
377-
:rtype: List[str]
378388
'''
379389

380390
# See comment in emit_load_commands()

0 commit comments

Comments
 (0)