Refactor the section of plugin tutorials to use double colons

ros-navigation · Mar 28, 2024 · 9c6e1a2 · 9c6e1a2
1 parent 4b56b20
commit 9c6e1a2
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/plugin_tutorials/docs/writing_new_behavior_plugin.rst b/plugin_tutorials/docs/writing_new_behavior_plugin.rst
@@ -172,7 +172,7 @@ It is good practice to place these lines at the end of the file but technically,
 .. code-block:: xml
 
   <library path="nav2_sms_behavior_plugin">
-    <class name="nav2_sms_behavior/SendSms" type="nav2_sms_behavior::SendSms" base_class_type="nav2_core::Behavior">
+    <class type="nav2_sms_behavior::SendSms" base_class_type="nav2_core::Behavior">
       <description>This is an example plugin which produces an SMS text message recovery.</description>
     </class>
   </library>
@@ -246,7 +246,7 @@ with
       wait:
         plugin: "nav2_behaviors::Wait"
       send_sms:
-        plugin: "nav2_sms_behavior/SendSms"
+        plugin: "nav2_sms_behavior::SendSms"
       account_sid: ... # your sid
       auth_token: ... # your token
       from_number: ... # your number

diff --git a/plugin_tutorials/docs/writing_new_costmap2d_plugin.rst b/plugin_tutorials/docs/writing_new_costmap2d_plugin.rst
@@ -152,7 +152,7 @@ This part is usually placed at the end of cpp-file where the plugin class was wr
 .. code-block:: xml
 
   <library path="nav2_gradient_costmap_plugin_core">
-    <class name="nav2_gradient_costmap_plugin/GradientLayer" type="nav2_gradient_costmap_plugin::GradientLayer" base_class_type="nav2_costmap_2d::Layer">
+    <class type="nav2_gradient_costmap_plugin::GradientLayer" base_class_type="nav2_costmap_2d::Layer">
       <description>This is an example plugin which puts repeating costs gradients to costmap</description>
     </class>
   </library>
@@ -223,11 +223,11 @@ In this case each plugin object will be handled by its own parameters tree in a
 .. code-block:: text
 
   gradient_layer_1:
-    plugin: nav2_gradient_costmap_plugin/GradientLayer
+    plugin: nav2_gradient_costmap_plugin::GradientLayer
     enabled: True
     ...
   gradient_layer_2:
-    plugin: nav2_gradient_costmap_plugin/GradientLayer
+    plugin: nav2_gradient_costmap_plugin::GradientLayer
     enabled: False
     ...
 

diff --git a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst
@@ -267,7 +267,7 @@ To enable the plugin, we need to modify the ``nav2_params.yaml`` file as below
         max_angular_vel: 1.0
         transform_tolerance: 1.0
 
-In the above snippet, you can observe the mapping of our ``nav2_pure_pursuit_controller/PurePursuitController`` controller to its id ``FollowPath``. 
+In the above snippet, you can observe the mapping of our ``nav2_pure_pursuit_controller::PurePursuitController`` controller to its id ``FollowPath``. 
 To pass plugin-specific parameters we have used ``<plugin_id>.<plugin_specific_parameter>``.
 
 4- Run Pure Pursuit Controller plugin

diff --git a/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst b/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst
@@ -162,7 +162,7 @@ It is good practice to place these lines at the end of the file, but technically
 .. code-block:: xml
 
   <library path="nav2_straightline_planner_plugin">
-    <class name="nav2_straightline_planner/StraightLine" type="nav2_straightline_planner::StraightLine" base_class_type="nav2_core::GlobalPlanner">
+    <class type="nav2_straightline_planner::StraightLine" base_class_type="nav2_core::GlobalPlanner">
       <description>This is an example plugin which produces straight path.</description>
     </class>
   </library>
@@ -214,10 +214,10 @@ with
       plugins: ["GridBased"]
       use_sim_time: True
       GridBased:
-        plugin: "nav2_straightline_planner/StraightLine"
+        plugin: "nav2_straightline_planner::StraightLine"
         interpolation_resolution: 0.1
 
-In the above snippet, you can observe the mapping of our ``nav2_straightline_planner/StraightLine`` planner to its id ``GridBased``. To pass plugin-specific parameters, we have used ``<plugin_id>.<plugin_specific_parameter>``.
+In the above snippet, you can observe the mapping of our ``nav2_straightline_planner::StraightLine`` planner to its id ``GridBased``. To pass plugin-specific parameters, we have used ``<plugin_id>.<plugin_specific_parameter>``.
 
 4- Run StraightLine plugin
 ---------------------------