Skip to content

Commit 6511982

Browse files
committed
doc: clarifies what is module root name for switch sub-cmd
1 parent 44ca7ac commit 6511982

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/source/module.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2754,8 +2754,9 @@ Module Sub-Commands
27542754
.. subcmd:: switch [options] [modulefile1] modulefile2
27552755

27562756
Switch loaded *modulefile1* with *modulefile2*. If *modulefile1* is not
2757-
specified, then it is assumed to be the currently loaded module with the
2758-
same root name as *modulefile2*.
2757+
specified, it is assumed to be the currently loaded module that shares the
2758+
same root name as *modulefile2*. The root name is defined as the initial part
2759+
of a module name, i.e., all characters preceding the first ``/``.
27592760

27602761
:subcmd:`switch` command accepts the following options:
27612762

0 commit comments

Comments
 (0)