diff --git a/configuration/packages/bt-plugins/actions/ComputePathToPose.rst b/configuration/packages/bt-plugins/actions/ComputePathToPose.rst index 014f0a98a2..49aaf783a8 100644 --- a/configuration/packages/bt-plugins/actions/ComputePathToPose.rst +++ b/configuration/packages/bt-plugins/actions/ComputePathToPose.rst @@ -19,7 +19,18 @@ Input Ports ===================================== ======= Description - Start pose. Optional. Only used if not left empty. Takes in a blackboard variable, e.g. "{start}". + Start pose. Optional. Used as the planner start pose instead of the current robot pose, if ``use_start`` is not false (i.e. not provided or set to true). Takes in a blackboard variable, e.g. "{start}". + +:use_start: + + ===================================== ======= + Type Default + ------------------------------------- ------- + geometry_msgs::msg::PoseStamped N/A + ===================================== ======= + + Description + Optional. For using or not using (i.e. ignoring) the provided start pose ``start``. Takes in a blackboard variable, e.g. "{use_start}". :goal: