[JTC] Add note on goal_time=0 in docs (backport ros-controls#773)

christophfroehlich · Nov 30, 2023 · 49f8df8 · 49f8df8
1 parent 7d9d076
commit 49f8df8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/joint_trajectory_controller/doc/parameters.rst b/joint_trajectory_controller/doc/parameters.rst
@@ -83,6 +83,7 @@ constraints.stopped_velocity_tolerance (double)
 
 constraints.goal_time (double)
   Maximally allowed tolerance for not reaching the end of the trajectory in a predefined time.
+  If set to zero, the controller will wait a potentially infinite amount of time.
 
   Default: 0.0 (not checked)
 

diff --git a/joint_trajectory_controller/src/joint_trajectory_controller_parameters.yaml b/joint_trajectory_controller/src/joint_trajectory_controller_parameters.yaml
@@ -138,7 +138,8 @@ joint_trajectory_controller:
     goal_time: {
       type: double,
       default_value: 0.0,
-      description: "Time tolerance for achieving trajectory goal before or after commanded time.",
+      description: "Time tolerance for achieving trajectory goal before or after commanded time.
+        If set to zero, the controller will wait a potentially infinite amount of time.",
       validation: {
         gt_eq: [0.0],
       }