Fix two HIGH-severity tutorial bugs (CMake example + rviz image publisher) - #34
Merged
Merged
Conversation
- cmake example: rename project test_proxsuite -> test_qpoases so the built source matches the file shown to the reader (src/test_qpoases.cpp), and drop the spurious Eigen dependency. Update the lesson's warning, the :emphasize-lines: offset, and the test_dqrobotics.cpp download label to stay consistent. - transformations/rviz.rst: 'Publish sample images' now uses the real ROS2 image_publisher package (Jazzy executable image_publisher_node) instead of the non-existent 'rqt_image_view image_publisher'. Remap image_raw to /images to match the visualiser, and fix the tab title. - Add ISSUES.md tracking the full static audit (both HIGH items marked fixed; MEDIUM/LOW items listed for follow-up). Co-authored-by: openhands <openhands@all-hands.dev>
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.
This PR fixes the two HIGH-severity issues found during a full static + manual audit of the tutorial.
1. CMake example built a source file that does not exist
cmake_tutorial_workspace/src/cpp_cmake_example_qpoases_lib/CMakeLists.txtdeclared
project(test_proxsuite)andadd_executable(${PROJECT_NAME} ${PROJECT_NAME}.cpp), i.e. ittried to build
test_proxsuite.cpp— which does not exist. The only C++ source present (and theone shown to the reader in the
test_qpoases.cpptab) issrc/test_qpoases.cpp.It also had
FIND_PACKAGE(Eigen3 REQUIRED)even though the example never uses Eigen.A reader following Install a CMake package → Example: include and link the qpOASES in your project
(
docs/source/cmake/cmake_packages_without_sudo.rst) would have failed at the build step.Fix:
project(test_proxsuite)→project(test_qpoases)${PROJECT_NAME}.cpp→src/${PROJECT_NAME}.cpp:emphasize-lines:offset (17 → 15, since two lines were removed above it), and fixed the downloadlabel
test_dqrobotics.cpp→test_qpoases.cppso it matches the tab title and the actual file.2.
transformations/rviz.rst: "Publish sample images" used a non-existent executableThe tab Terminal 1: Publish sample images instructed
ros2 run rqt_image_view image_publisher.rqt_image_viewis a visualiser, not a publisher —there is no
image_publisherexecutable in it, so the command fails. The following sentence even says"We will use the visualiser, not the publisher", confirming a publisher was intended.
Fix: use the real ROS2
image_publisherpackage (ships withros-desktop, so readers have it).On Jazzy its executable is
image_publisher_node; it takes an image path and publishes onimage_raw,so the topic is remapped to
/imagesto match the visualiser:Also corrected the second tab title from "Run the bridge" to "Run the visualiser".
3. Tracking
Added
ISSUES.mdat the repo root with the full audit. Both HIGH items are marked[x]fixed; theremaining MEDIUM (dead pages, stale Humble/Foxy links) and LOW items are listed with severity,
file:line, and a suggested fix so they can be addressed in a follow-up PR.Created by an AI agent (OpenHands) on behalf of the user.