Add more details for class name (#626)

* Add more details for class name Signed-off-by: Maurice-1235 <[email protected]> * Fix indent Signed-off-by: Maurice-1235 <[email protected]> --------- Signed-off-by: Maurice-1235 <[email protected]>
ros-navigation · Jan 3, 2025 · 099a969 · 099a969
1 parent 902167a
commit 099a969
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
 _build
+lib/
+bin/
+pyvenv.cfg
diff --git a/plugin_tutorials/docs/writing_new_behavior_plugin.rst b/plugin_tutorials/docs/writing_new_behavior_plugin.rst
@@ -164,7 +164,7 @@ It is good practice to place these lines at the end of the file but technically,
 2. Next step would be to create plugin's description file in the root directory of the package. For example, ``behavior_plugin.xml`` file in our tutorial package. This file contains following information
 
  - ``library path``: Plugin's library name and it's location.
- - ``class name``: Name of the class.
+ - ``class name``: Name of the class (optional). If not set, it will default to the ``class type``.
  - ``class type``: Type of class.
  - ``base class``: Name of the base class.
  - ``description``: Description of the plugin.

diff --git a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst
@@ -221,7 +221,7 @@ It is good practice to place these lines at the end of the file, but technically
 2. The next step would be to create the plugin's description file in the root directory of the package. For example, ``pure_pursuit_controller_plugin.xml`` file in our tutorial package. This file contains the following information
 
 - ``library path``: Plugin's library name and its location.
-- ``class name``: Name of the class.
+- ``class name``: Name of the class (optional). If not set, it will default to the ``class type``.
 - ``class type``: Type of class.
 - ``base class``: Name of the base class.
 - ``description``: Description of the plugin.

diff --git a/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst b/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst
@@ -154,7 +154,7 @@ It is good practice to place these lines at the end of the file, but technically
 2. Next step would be to create plugin's description file in the root directory of the package. For example, ``global_planner_plugin.xml`` file in our tutorial package. This file contains the following information
 
  - ``library path``: Plugin's library name and its location.
- - ``class name``: Name of the class.
+ - ``class name``: Name of the class (optional). If not set, it will default to the ``class type``.
  - ``class type``: Type of class.
  - ``base class``: Name of the base class.
  - ``description``: Description of the plugin.

diff --git a/plugin_tutorials/docs/writing_new_navigator_plugin.rst b/plugin_tutorials/docs/writing_new_navigator_plugin.rst
@@ -280,7 +280,7 @@ It is good practice to place these lines at the end of the file, but technically
 2. The next step would be to create the plugin's description file in the root directory of the package. For example, ``navigator_plugin.xml`` file in our tutorial package. This file contains the following information
 
 - ``library path``: Plugin's library name and it's location.
-- ``class name``: Name of the class.
+- ``class name``: Name of the class (optional). If not set, it will default to the ``class type``.
 - ``class type``: Type of class.
 - ``base class``: Name of the base class.
 - ``description``: Description of the plugin.