feat(docs): update command docs#1007
feat(docs): update command docs#1007TetsuKawa wants to merge 6 commits intofeat/change-bridge-meaning-node-info-agnocastfrom
Conversation
Signed-off-by: TetsuKawa <kawaguchitnon@icloud.com>
Signed-off-by: TetsuKawa <kawaguchitnon@icloud.com>
Signed-off-by: TetsuKawa <kawaguchitnon@icloud.com>
TetsuKawa
added
the
need-patch-update
Signed-off-by: TetsuKawa <kawaguchitnon@icloud.com>
TetsuKawa
requested review from
Koichi98,
atsushi421 and
sykwer
as code owners
There was a problem hiding this comment.
Pull request overview
Updates the ROS 2 command extension documentation to reflect recent changes, especially around *_agnocast variants and bridging visibility.
Changes:
- Added/expanded documentation for
ros2 node list_agnocastand its debug output. - Documented how
(Agnocast enabled, bridged)is displayed for topics and nodes, including a Pub/Sub matrix. - Adjusted section structure (e.g., “Debug Mode” subsections) for topic/node commands.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/ros2_command_extension.md
Outdated
| | pub | sub | bridge | display | | ||
| | :--- | :--- | :--- | :--- | | ||
| | rclcpp::publisher | rclcpp::subscription | off / standard / performance | /my_topic | | ||
| | agnocast::publisher | rclcpp::subscription | off | /my_topic (WARN: Agnocast and ROS2 endpoints exist but bridge is not active) | |
There was a problem hiding this comment.
The table uses || at the start of each row, which is not standard Markdown table syntax and may render incorrectly (extra empty column or broken table) depending on the renderer. Use single leading/trailing pipes with a consistent column count, e.g. | pub | sub | bridge | display | and | --- | --- | --- | --- |.
There was a problem hiding this comment.
That point is incorrect.
| /topic_name3 | ||
| ``` | ||
|
|
||
| This does not necessarily mean that a bridge process is currently running. If there is only one Agnocast publisher and no ROS 2 subscriber, the topic will be displayed simply as "(Agnocast enabled)" rather than including the "bridged" suffix. The "bridged" status indicates that communication has been successfully established between Agnocast and ROS 2. |
There was a problem hiding this comment.
These sentences define (Agnocast enabled, bridged) as indicating successful communication, but later state it can still be displayed even when communication is not established (type mismatch). To avoid contradiction, consider redefining bridged more precisely (e.g., ‘bridge endpoints detected and bridge mode active’) and keep the note that type mismatches prevent actual data exchange even though the UI shows bridged.
There was a problem hiding this comment.
A type mismatch is considered a mistake by the application developer, and it can be detected using the ros2 topic info_agnocast command. As you pointed out, labeling it as "bridged" may lead users to believe that communication is functioning normally. This section is intended to explain that specific limitation.
|
|
||
| #### Notes | ||
|
|
||
| - If an Agnocast topic and a ROS 2 topic share the same name but have different message types, the status will still be displayed as (Agnocast enabled, bridged). However, in this case, the actual communication will not be established. |
There was a problem hiding this comment.
These sentences define (Agnocast enabled, bridged) as indicating successful communication, but later state it can still be displayed even when communication is not established (type mismatch). To avoid contradiction, consider redefining bridged more precisely (e.g., ‘bridge endpoints detected and bridge mode active’) and keep the note that type mismatches prevent actual data exchange even though the UI shows bridged.
There was a problem hiding this comment.
A type mismatch is considered a mistake by the application developer, and it can be detected using the ros2 topic info_agnocast command. As you pointed out, labeling it as "bridged" may lead users to believe that communication is functioning normally. This section is intended to explain that specific limitation.
Koichi98
changed the base branch from
main
to
feat/change-bridge-meaning-node-info-agnocast
|
@TetsuKawa |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2 participants
Description
Updated the command extension doc file following PR:
Related links
How was this PR tested?
bash scripts/e2e_test_1to1_with_ros2sub(required)bash scripts/e2e_test_2to2(required)Notes for reviewers
Version Update Label (Required)
Please add exactly one of the following labels to this PR:
need-major-update: User API breaking changesneed-minor-update: Internal API breaking changes (heaphook/kmod/agnocastlib compatibility)need-patch-update: Bug fixes and other changesImportant notes:
need-major-updateorneed-minor-update, please include this in the PR title as well.fix(foo)[needs major version update]: barorfeat(baz)[needs minor version update]: quxrun-build-testlabel. The PR can only be merged after the build tests pass.See CONTRIBUTING.md for detailed versioning rules.