adding API change for spin_until_complete (#3328)

Signed-off-by: stevemacenski <[email protected]> (cherry picked from commit fd9adb8) # Conflicts: # source/Tutorials/Advanced/FastDDS-Configuration.rst # source/Tutorials/Beginner-Client-Libraries/Custom-ROS2-Interfaces.rst
ros2 · Feb 13, 2023 · c260d20 · c260d20
1 parent ec1cd20
commit c260d20
Show file tree

Hide file tree

Showing 7 changed files with 859 additions and 4 deletions.
diff --git a/source/Releases/Release-Iron-Irwini.rst b/source/Releases/Release-Iron-Irwini.rst
@@ -41,6 +41,13 @@ To come.
 New features in this ROS 2 release
 ----------------------------------
 
+Rename ``spin_until_future_complete`` to ``spin_until_complete``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`PR 1874 <https://github.com/ros2/rclcpp/pull/1874>`_ renames ``spin_until_future_complete`` to ``spin_until_complete`` to represent the semantics of being able to spin on values that are not exclusively futures.
+The API can now spin until arbitrary conditions.
+A deprecation warning will appear for migration.
+
 ros2topic
 ^^^^^^^^^
 

diff --git a/source/The-ROS2-Project/Contributing/Migration-Guide-Python.rst b/source/The-ROS2-Project/Contributing/Migration-Guide-Python.rst
@@ -121,4 +121,4 @@ In ROS 2:
    while not add_two_ints.wait_for_service(timeout_sec=1.0):
        node.get_logger().info('service not available, waiting again...')
    resp = add_two_ints.call_async(req)
-   rclpy.spin_until_future_complete(node, resp)
+   rclpy.spin_until_complete(node, resp)