Skip to content

Commit 6fcc79e

Browse files
Document substitutions concatenation in architecture doc (#845)
Signed-off-by: Christophe Bedard <[email protected]>
1 parent 3694dc2 commit 6fcc79e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

launch/doc/source/architecture.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ There are many possible variations of a substitution, but here are some of the c
120120
- :class:`launch.substitutions.Text`
121121

122122
- This substitution simply returns the given string when evaluated.
123-
- It is usually used to wrap literals in the launch description so they can be concatenated with other substitutions.
123+
- It is usually used to normalize literals by wrapping them into substitutions in the launch description so they can be concatenated with other substitutions (see :func:`launch.utilities.normalize_to_list_of_substitutions`).
124+
- An iterable of substitutions is concatenated into a single string (see :func:`launch.utilities.perform_substitutions`).
124125

125126
- :class:`launch.substitutions.PythonExpression`
126127

0 commit comments

Comments
 (0)