Fix spelling and grammar issues in Task Server documentation #683
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SteveMacenski
requested changes
May 1, 2025
| @@ -3,24 +3,24 @@ | |||
| Adding a New Nav2 Task Server | |||
| ############################# | |||
|
|
|||
| A nav2 task server consists of server side logic to complete different types of requests, usually called by the autonomy system or through the Behavior Tree Navigator. In this guide, we will discuss the core components needed to add a new task server to Nav2 (ex. Controller, Behavior, Smoother, Planner Servers). Namely, how to set up your new Lifecycle-Component Node for launch and state management and the communication of semantically meaningful error codes (if necessary). | |||
| A nav2 task server consists of server-side logic logic to complete different types of requests, usually called by the autonomy system or through the Behavior Tree Navigator. In this guide, we will discuss the core components needed to add a new task server to Nav2 (ex. Controller, Behavior, Smoother, Planner Servers). Namely, how to set up your new Lifecycle-Component Node for launch and state management and the communication of semantically meaningful error codes (if necessary). | |||
|
|
||
| While this tutorial does not cover how to add the complementary Behavior Tree Node to interact with this new Task Server, that is covered at length in :ref:`writing_new_nbt_plugin` so this Task Server can be invoked in the BTs in BT Navigator. | ||
| While this tutorial does not cover how to add the complementary Behavior Tree Node to interact with this new Task Server; that is covered at length in :ref:`writing_new_nbt_plugin` so this Task Server can be invoked in the BTs in BT Navigator. |
There was a problem hiding this comment.
I think this should stay a , given its the second half of the sentence after "While ..., ...."
There was a problem hiding this comment.
You're absolutely right about the comma ! just fixed that, along with the repetition of logic. Should be all good now
SteveMacenski
approved these changes
May 1, 2025
|
@Clement795 please sign off with DCO - click on the failed job to see how. Then I can merge! |
Signed-off-by: Clement795 <clement.lepretre4@gmail.com>
Signed-off-by: Clement795 <clement.lepretre4@gmail.com>
Clement795
force-pushed
the
fix/docs-nav2-task-server-grammar
branch
from
cf156f6 to
c71c0d0
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I just completed the tutorial and noticed a few spelling errors in the documentation. I've gone ahead and corrected them to improve clarity and consistency. The changes mainly involve minor typos, such as the incorrect usage of "errors codes" instead of "error codes".
Let me know if you need any further adjustments or clarifications.
Thanks!