Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more details for class name #626

Merged
merged 2 commits into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
SteveMacenski marked this conversation as resolved.
Show resolved Hide resolved
- ``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.
SteveMacenski marked this conversation as resolved.
Show resolved Hide resolved
- ``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
Loading