Improve documentation for TransformStamped.msg (#113)

* Improve documentation for TransformStamped.msg Fixes #94 Signed-off-by: Tully Foote <[email protected]>
ros2 · May 19, 2020 · 51c0e0c · 51c0e0c
1 parent fc62aeb
commit 51c0e0c
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/geometry_msgs/msg/TransformStamped.msg b/geometry_msgs/msg/TransformStamped.msg
@@ -1,9 +1,13 @@
 # This expresses a transform from coordinate frame header.frame_id
-# to the coordinate frame child_frame_id
+# to the coordinate frame child_frame_id at the time of header.stamp
 #
 # This message is mostly used by the
-# <a href="http://www.ros.org/wiki/tf">tf</a> package.
+# <a href="https://index.ros.org/p/tf2/">tf2</a> package.
 # See its documentation for more information.
+#
+# The child_frame_id is necessary in addition to the frame_id
+# in the Header to communicate the full reference for the transform
+# in a self contained message. 
 
 std_msgs/Header header
 string child_frame_id # the frame id of the child frame