clarify difference between faliure and error : issue-3086 - #3215
clarify difference between faliure and error : issue-3086#3215AdityaJindal07 wants to merge 1 commit into
Conversation
Signed-off-by: Aditya Jindal <adityajindal704@gmail.com>
|
Tick the box to add this pull request to the merge queue (same as
|
|
Pulls: #3215
|
|
IMO the wording in #3087 was substantially clearer |
solonovamax
left a comment
solonovamax
left a comment
There was a problem hiding this comment.
overall, I would just keep the exact wording #3087 had. it was perfectly fine and did not need adjusting.
| SUCCESS = lifecycle_msgs::msg::Transition::TRANSITION_CALLBACK_SUCCESS, | ||
|
|
||
| /// The callback completed, but the requested transition could not | ||
| /// be completed. The node returns to a stable lifecycle state. |
There was a problem hiding this comment.
what is "a stable lifecycle state"
if I did not know what this did, this would leave me more confused, not less.
| /// be completed. The node returns to a stable lifecycle state. | ||
| FAILURE = lifecycle_msgs::msg::Transition::TRANSITION_CALLBACK_FAILURE, | ||
|
|
||
| /// An unexpected error occurred. The node enters the |
There was a problem hiding this comment.
"The node transitions to" was just better wording
|
@solonovamax thanks for reviewing this! @AdityaJindal07 can you address comments? |
|
Sure @fujitatomoya , I'll make the required changes and update it accordingly. |
3 participants
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.