Skip to content

adding API change for spin_until_complete (backport #3328) #3330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mergify wants to merge 1 commit into from
Closed

adding API change for spin_until_complete (backport #3328) #3330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions source/Releases/Release-Iron-Irwini.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion source/The-ROS2-Project/Contributing/Migration-Guide-Python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading