Skip to content

Commit 1892276

Browse files
author
GueLaKais
committed
added pydoc comments to _prepare method of AmentCargoBuildTask method
1 parent b1feb68 commit 1892276

File tree

1 file changed

+11
-0
lines changed
  • colcon_ros_cargo/task/ament_cargo

1 file changed

+11
-0
lines changed

colcon_ros_cargo/task/ament_cargo/build.py

+11
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,17 @@ def add_arguments(self, *, parser): # noqa: D102
6262
'.cargo/config.toml for subsequent builds with cargo.')
6363

6464
def _prepare(self, env, additional_hooks):
65+
"""
66+
Prepare the build environment.
67+
68+
This method resolves the package paths for dependencies, writes the
69+
resolved paths to a .cargo/config.toml file, and creates an environment
70+
hook for the AMENT_PREFIX_PATH.
71+
72+
Args:
73+
env: The environment to prepare.
74+
additional_hooks: Additional hooks to be executed.
75+
"""
6576
args = self.context.args
6677

6778
global package_paths

0 commit comments

Comments
 (0)