Skip to content

Commit c260d20

Browse files
SteveMacenskimergify[bot]
authored andcommitted
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
1 parent ec1cd20 commit c260d20

File tree

7 files changed

+859
-4
lines changed

7 files changed

+859
-4
lines changed

source/Releases/Release-Iron-Irwini.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ To come.
4141
New features in this ROS 2 release
4242
----------------------------------
4343

44+
Rename ``spin_until_future_complete`` to ``spin_until_complete``
45+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46+
47+
`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.
48+
The API can now spin until arbitrary conditions.
49+
A deprecation warning will appear for migration.
50+
4451
ros2topic
4552
^^^^^^^^^
4653

source/The-ROS2-Project/Contributing/Migration-Guide-Python.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,4 @@ In ROS 2:
121121
while not add_two_ints.wait_for_service(timeout_sec=1.0):
122122
node.get_logger().info('service not available, waiting again...')
123123
resp = add_two_ints.call_async(req)
124-
rclpy.spin_until_future_complete(node, resp)
124+
rclpy.spin_until_complete(node, resp)

0 commit comments

Comments
 (0)