Skip to content

Commit

Permalink
Add more details for class name
Browse files Browse the repository at this point in the history
Signed-off-by: Maurice-1235 <[email protected]>
  • Loading branch information
mini-1235 committed Jan 2, 2025
1 parent 9023e68 commit 5118b9a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
_build
lib/
bin/
pyvenv.cfg
2 changes: 1 addition & 1 deletion plugin_tutorials/docs/writing_new_behavior_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions plugin_tutorials/docs/writing_new_nav2controller_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion plugin_tutorials/docs/writing_new_nav2planner_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions plugin_tutorials/docs/writing_new_navigator_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5118b9a

Please sign in to comment.