Skip to content

Commit

Permalink
Clarify the documentation for the parameter value of ShellExtensionPo…
Browse files Browse the repository at this point in the history
…int.create_hook_set_value() for the case an empty string is passed
  • Loading branch information
meyerj committed Aug 18, 2023
1 parent efbc721 commit 61724cd
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion colcon_core/shell/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,11 @@ def create_hook_set_value(
:param str pkg_name: The package name
:param str name: The name of the environment variable
:param str value: The value to be set. If an empty string is passed the
environment variable should be set to the prefix path.
environment variable should be set to the prefix path at the time the
hook is sourced (from COLCON_CURRENT_PREFIX).
Note that the install-space may have been relocated, and the final
value may differ from the from the value of argument prefix_path,
where the hook has originally been installed to.
:returns: The relative path to the created hook script
:rtype: Path
"""
Expand Down

0 comments on commit 61724cd

Please sign in to comment.