Skip to content

Commit 5a69a44

Browse files
authored
Minor improvement on best practice for pluginlib export (#1637)
1 parent 83054e6 commit 5a69a44

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

‎sphinx_doc/tutorials/docs/writing_new_costmap2d_plugin.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ In our example the ``nav2_gradient_costmap_plugin::GradientLayer`` plugin's clas
139139
#include "pluginlib/class_list_macros.hpp"
140140
PLUGINLIB_EXPORT_CLASS(nav2_gradient_costmap_plugin::GradientLayer, nav2_costmap_2d::Layer)
141141
142-
This part is usually placed at the end of cpp-file where the plugin class was written (in our example ``gradient_layer.cpp``).
142+
This part is usually placed at the end of cpp-file where the plugin class was written (in our example ``gradient_layer.cpp``). It is good practice to place these lines at the end of the file but technically, you can also place at the top.
143143

144144
2. Plugin's inormation should be stored to plugin description file. This is done by using separate XML (in our example ``gradient_plugins.xml``) in the plugin's package. This file contains information about:
145145

0 commit comments

Comments
 (0)