From 5118b9a5fff58b91e98a26ac98f1c112c876b5cd Mon Sep 17 00:00:00 2001 From: Maurice-1235 Date: Fri, 3 Jan 2025 04:23:51 +0800 Subject: [PATCH 1/2] Add more details for class name Signed-off-by: Maurice-1235 --- .gitignore | 3 +++ plugin_tutorials/docs/writing_new_behavior_plugin.rst | 2 +- .../docs/writing_new_nav2controller_plugin.rst | 10 +++++----- .../docs/writing_new_nav2planner_plugin.rst | 2 +- plugin_tutorials/docs/writing_new_navigator_plugin.rst | 10 +++++----- 5 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.gitignore b/.gitignore index e35d8850c..d96903f2c 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ _build +lib/ +bin/ +pyvenv.cfg \ No newline at end of file diff --git a/plugin_tutorials/docs/writing_new_behavior_plugin.rst b/plugin_tutorials/docs/writing_new_behavior_plugin.rst index 045e381e4..f08a37889 100644 --- 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 index 52c7e27b0..16fd0cc7e 100644 --- a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst +++ b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst @@ -220,11 +220,11 @@ 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 type``: Type of class. -- ``base class``: Name of the base class. -- ``description``: Description of the plugin. + - ``library path``: Plugin's library name and its location. + - ``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. .. code-block:: xml diff --git a/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst b/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst index 9dd5a1762..646547e65 100644 --- 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 index 29c3a36cf..efcf3cf80 100644 --- a/plugin_tutorials/docs/writing_new_navigator_plugin.rst +++ b/plugin_tutorials/docs/writing_new_navigator_plugin.rst @@ -279,11 +279,11 @@ 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 type``: Type of class. -- ``base class``: Name of the base class. -- ``description``: Description of the plugin. + - ``library path``: Plugin's library name and it's location. + - ``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. .. code-block:: xml From ee021321be6b4dd41ab701875c9a5378b3cf889f Mon Sep 17 00:00:00 2001 From: Maurice-1235 Date: Fri, 3 Jan 2025 04:42:51 +0800 Subject: [PATCH 2/2] Fix indent Signed-off-by: Maurice-1235 --- .../docs/writing_new_nav2controller_plugin.rst | 10 +++++----- plugin_tutorials/docs/writing_new_navigator_plugin.rst | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst index 16fd0cc7e..07d3a4215 100644 --- a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst +++ b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst @@ -220,11 +220,11 @@ 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 (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. +- ``library path``: Plugin's library name and its location. +- ``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. .. code-block:: xml diff --git a/plugin_tutorials/docs/writing_new_navigator_plugin.rst b/plugin_tutorials/docs/writing_new_navigator_plugin.rst index efcf3cf80..fff8d4d56 100644 --- a/plugin_tutorials/docs/writing_new_navigator_plugin.rst +++ b/plugin_tutorials/docs/writing_new_navigator_plugin.rst @@ -279,11 +279,11 @@ 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 (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. +- ``library path``: Plugin's library name and it's location. +- ``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. .. code-block:: xml