Skip to content

Commit

Permalink
fix spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
aosmw committed Aug 31, 2024
1 parent 61cc31a commit 795dcae
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion migration/Jazzy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ BehaviorTree error_msg
**********************

`PR #4459 https://github.com/ros-navigation/navigation2/pull/4459>`_ adds error_msg to all action result messages
`PR #4460 <https://github.com/ros-navigation/navigation2/pull/4460>`_ captures and propogates error_msg result strings through the bt_navigator.
`PR #4460 <https://github.com/ros-navigation/navigation2/pull/4460>`_ captures and propagates error_msg result strings through the bt_navigator.

A new parameter for the BT Navigator "error_code_name_prefixes" was introduced. It replaces the "error_code_id_names" parameter to support both an error code and an associated error message. Behavior tree elements that support an "error_code_id" and "error_msg" attribute, must have values that use the corresponding prefix with the suffix "_error_code" and "_error_msg" respectively.

Expand Down
2 changes: 1 addition & 1 deletion tutorials/docs/adding_a_nav2_task_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The table below shows the current servers along with the expected error code str
.. _Waypoint Follower Server: https://github.com/ros-planning/navigation2/blob/main/nav2_waypoint_follower/src/waypoint_follower.cpp
.. _Behavior Server: https://github.com/ros-planning/navigation2/blob/main/nav2_behaviors/src/behavior_server.cpp

Error codes and messages are attached to the response of the action message. An example can be seen below for the route server. Note it is neccesary to set the error code field within the message result definition to ``error_code`` and the error message field to ``error_msg``.
Error codes and messages are attached to the response of the action message. An example can be seen below for the route server. Note it is necessary to set the error code field within the message result definition to ``error_code`` and the error message field to ``error_msg``.


.. code-block:: bash
Expand Down

0 comments on commit 795dcae

Please sign in to comment.