Fix Fibonacci action feedback field name#5965
Open
anishk85 wants to merge 1 commit intoros2:rollingfrom
Open
Conversation
- Change feedback field from 'sequence' to 'partial_sequence' - Updated in About-Interfaces.rst and About-Actions.rst - Aligns with actual action definition used in tutorials Fixes ros2#4298
Collaborator
fujitatomoya
left a comment
There was a problem hiding this comment.
@anishk85 thanks for addressing this documentation fix.
before moving on with this PR, i believe that we should 1st resolve the confusion mentioned #4298 (comment), then we can move on to the documentation fix. (depending on the approach, the documentation fix will be different.)
especially if we take #4298 (comment) this way suggested by @ahcorde , this fix will be really different.
Contributor
Author
Understanding the SituationThanks @fujitatomoya for the review! After reading through the discussion on #4298, I now understand the bigger picture. The Root CauseThere are 3 different Fibonacci action definitions across ROS 2 repos:
This creates confusion for learners! 🎯 Agreed Solution (per maintainer discussion)Phase 1: Standardize Source Packages
Phase 2: Fix Documentation (This PR)
Okay I will wait till the confusion is resolved. |
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
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.
Fixes #4298
Fixed two files:
About-Interfaces.rstAbout-Actions.rstChanged the feedback field from
sequence→partial_sequenceto match what the rest of the documentation and code use.In ROS 2 actions:
partial_sequence(progress updates while running)sequence(final answer when done)Having both called
sequencewas misleading!Small fix, but should help avoid confusion for people learning about actions!