Skip to content

Conversation

anishk85
Copy link
Contributor

  • 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 #4298

Fixed two files:

  • About-Interfaces.rst
  • About-Actions.rst

Changed the feedback field from sequencepartial_sequence to match what the rest of the documentation and code use.

In ROS 2 actions:

  • Feedback = partial_sequence (progress updates while running)
  • Result = sequence (final answer when done)

Having both called sequence was misleading!

Small fix, but should help avoid confusion for people learning about actions!

- 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
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@anishk85
Copy link
Contributor Author

Understanding the Situation

Thanks @fujitatomoya for the review! After reading through the discussion on #4298, I now understand the bigger picture.

The Root Cause

There are 3 different Fibonacci action definitions across ROS 2 repos:

Repository Feedback Field Status
action_tutorials_interfaces partial_sequence ✅ Correct
example_interfaces sequence ❌ Needs fix
test_interface_files sequence ❌ Needs fix
ros2_documentation (concepts) sequence ❌ Needs fix
ros2_documentation (tutorials) partial_sequence ✅ Correct

This creates confusion for learners!


🎯 Agreed Solution (per maintainer discussion)

Phase 1: Standardize Source Packages

  1. Keep example_interfaces/action/Fibonacci.action as canonical
  2. Fix its feedback field: sequencepartial_sequence
  3. Remove action_tutorials_interfaces (duplicate)
  4. Remove test_interface_files/action/Fibonacci.action (duplicate)
  5. Update all code importing these actions

Phase 2: Fix Documentation (This PR)

  • Update About-Actions.rst
  • Update About-Interfaces.rst

Okay I will wait till the confusion is resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

typo: Fibonacci feedback_fieldname: sequence -> partial_sequence

2 participants