Fix verified tutorial documentation inconsistencies - #33
Merged
Conversation
- Fix MoveStraightIn2D.action field name from 'error_norm' to 'distance' and update description to match actual source file - Update index.rst to acknowledge arm64 support alongside x64
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.
Summary
This PR fixes two issues discovered by running the full tutorial step-by-step inside a Docker container (
ubuntu:noble, arm64).Fixes
1.
MoveStraightIn2D.actionfield name mismatch (create_interface_package.rst)The
ros2 interface showoutput for the action was hardcoded in the documentation with the wrong field name and description:# Feedback is the norm of the error between ...# Feedback is the Euclidean distance between ...float32 error_normfloat32 distanceThe actual
.actionfile and all action server/client code already usefloat32 distance. This inconsistency would cause runtime errors for anyone copying the documented field nameerror_norminto their code.2. Architecture support acknowledgment (
index.rst)Updated the tutorial's stated platform focus from:
to:
ROS2 Jazzy on Ubuntu 24.04 works correctly on arm64 (verified during this review). Acknowledging this avoids confusion for users on ARM-based hardware (e.g. Raspberry Pi, Apple Silicon via Docker, AWS Graviton).
Issues Not Fixed
Issues #6 (empty emphasize lines in publishers/subscribers) and #8 (URL fix) were originally reported but were not fixed because:
:emphasize-lines:values inpublishers_and_subscribers.rstare correct — they point to the right lines. The original report had an off-by-one calculation error.ros-apt-source.debURL ininstallation.rstis already using the correctros-apt-sourceGitHub releases pattern. No stale URL exists.Verified Working
The following was verified in the Docker container before and after the fixes:
colcon buildros2 runnodes execute correctly (print_forever, library usage, pub/sub, services)ros2 interface showoutput matches the corrected documentation