Skip to content

Commit 7255890

Browse files
Document EnvironmentVariable substitution resolution context caveat (#541)
Signed-off-by: Christophe Bedard <[email protected]>
1 parent ec481fb commit 7255890

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

launch/launch/substitutions/environment_variable.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ class EnvironmentVariable(Substitution):
3333
Substitution that gets an environment variable value as a string.
3434
3535
If the environment variable is not found, it returns empty string.
36+
37+
Note that the environment variable is resolved based on the launch context's environment (i.e.,
38+
`os.environ`) even though the substitution may be associated with an entity that might have a
39+
different set of environment variables.
3640
"""
3741

3842
def __init__(

0 commit comments

Comments
 (0)