Document that Time and Duration are explictly ROS Time (#103)

Fixes #94 Signed-off-by: Tully Foote <[email protected]>
ros2 · Jun 19, 2020 · 5a4a3bd · 5a4a3bd
1 parent a460390
commit 5a4a3bd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/builtin_interfaces/msg/Duration.msg b/builtin_interfaces/msg/Duration.msg
@@ -1,5 +1,6 @@
-# Duration defines a period between two time points. It is comprised of a
-# seconds component and a nanoseconds component.
+# Duration defines a period between two time points.
+# Messages of this datatype are of ROS Time following this design:
+# https://design.ros2.org/articles/clock_and_time.html
 
 # Seconds component, range is valid over any possible int32 value.
 int32 sec

diff --git a/builtin_interfaces/msg/Time.msg b/builtin_interfaces/msg/Time.msg
@@ -1,4 +1,5 @@
-# Time indicates a specific point in time, relative to a clock's 0 point.
+# This message communicates ROS Time defined here:
+# https://design.ros2.org/articles/clock_and_time.html
 
 # The seconds component, valid over all int32 values.
 int32 sec