clarify difference between faliure and error : issue-3086 - #3215
Open
AdityaJindal07 wants to merge 1 commit into
Open
clarify difference between faliure and error : issue-3086#3215AdityaJindal07 wants to merge 1 commit into
AdityaJindal07 wants to merge 1 commit into
Conversation
Signed-off-by: Aditya Jindal <adityajindal704@gmail.com>
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
This was referenced Aug 2, 2026
fujitatomoya
approved these changes
Aug 2, 2026
Collaborator
|
Pulls: #3215
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Add documentation comments to
CallbackReturnto make the distinction betweenSUCCESS,FAILURE, andERRORclearer for developers implementing lifecyclecallbacks.
The new comments explain that:
SUCCESSindicates the callback completed successfully.FAILUREindicates the transition could not be completed and the node returns to a stable lifecycle state.ERRORindicates an unexpected error and the node enters the error-processing state.Fixes #3086
Is this user-facing behavior change?
No. This change only improves documentation and does not affect runtime behavior.
Did you use Generative AI?
Yes. ChatGPT (GPT-5.5) was used to help refine the wording of the documentation comments and PR description. The lifecycle behavior and state transitions were investigated and verified manually from the source code before making the changes.
Additional Information
This is my first contribution to Open Robotics. I spent some time tracing the lifecycle state machine to understand the difference between
FAILUREandERRORbefore updating the comments. I'd really appreciate any feedback on the wording or if there's a better way to document this distinction.