Skip to content

Commit fec3072

Browse files
committed
doc: desc. tag report on load/unload/refresh msg block
1 parent 8a68787 commit fec3072

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

NEWS.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,9 @@ Modules 5.1.0 (not yet released)
223223
added to those already set.
224224
* When reporting result of :subcmd:`avail` or :subcmd:`list` sub-commands,
225225
enclose module names in single quotes if they contain a space character.
226+
* When mentioning the loading, unloading or refreshing evaluation of a module,
227+
report the tags associated to this module as done when printing results of
228+
:subcmd:`list` sub-command.
226229

227230
.. _Code of conduct: https://github.com/cea-hpc/modules/blob/master/CODE_OF_CONDUCT.md
228231
.. _codespell: https://github.com/codespell-project/codespell

doc/source/design/module-tags.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,17 @@ Reporting
194194
- Tags are right-aligned on each column
195195
- One space character at least separates module name and version or list of symbolic version from tag list
196196

197+
- Defines tags are reported on module evaluation message block
198+
199+
- Applies to *Loading*, *Unloading*, *Refreshing* message blocks
200+
- Only for the module designation set in the header of the block
201+
202+
- Not on the error message, or list of requirement loaded/unloaded
203+
- To avoid overloading the output
204+
205+
- Tags are reported the same way than on ``list`` sub-command
206+
- If load evaluation fails, the tags are not reported as they were not yet set
207+
197208
- Tags applying to module alias are reported on ``avail`` reports only
198209

199210
- Where the module alias stands for itself in the report

doc/source/module.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2114,8 +2114,9 @@ already loaded, the additional tags are added to the list of tags already
21142114
applied to this module.
21152115

21162116
Module tags are reported along the module they are associated to on
2117-
:subcmd:`avail` and :subcmd:`list` sub-command results. Tags could be reported
2118-
either:
2117+
:subcmd:`avail` and :subcmd:`list` sub-command results and also when module's
2118+
loading, unloading or refreshing evaluation is mentioned. Tags could be
2119+
reported either:
21192120

21202121
* along the module name, all tags set within angle brackets, each tag
21212122
separated from the others with a colon character (e.g.,

0 commit comments

Comments
 (0)