Add deprecation nodte for Pose2D

This is a forward port of ros/common_msgs#130 This fixes #93 Signed-off-by: Tully Foote <[email protected]>
ros2 · Apr 11, 2020 · c994200 · c994200
1 parent 519e851
commit c994200
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/geometry_msgs/msg/Pose2D.msg b/geometry_msgs/msg/Pose2D.msg
@@ -1,4 +1,9 @@
-# This expresses a position and orientation on a 2D manifold.
+# Deprecated as of Foxy and will potentially be removed in any following release.
+# Please use the full 3D pose.
+
+# In general our recommendation is to use a full 3D representation of everything and for 2D specific applications make the appropriate projections into the plane for their calculations but optimally will preserve the 3D information during processing.
+
+# If we have parallel copies of 2D datatypes every UI and other pipeline will end up needing to have dual interfaces to plot everything. And you will end up with not being able to use 3D tools for 2D use cases even if they're completely valid, as you'd have to reimplement it with different inputs and outputs. It's not particularly hard to plot the 2D pose or compute the yaw error for the Pose message and there are already tools and libraries that can do this for you.# This expresses a position and orientation on a 2D manifold.
 
 float64 x
 float64 y