Skip to content

Document subordinate nodes aka sub-nodes #5457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 of 4 tasks
christophebedard opened this issue May 1, 2025 · 2 comments
Open
1 of 4 tasks

Document subordinate nodes aka sub-nodes #5457

christophebedard opened this issue May 1, 2025 · 2 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@christophebedard
Copy link
Member

christophebedard commented May 1, 2025

Issue Type

  • 🐛 Bug / Problem
  • ✏️ Typo / Grammar
  • 📖 Outdated Content
  • 🚀 Enhancement

Distribution

all

Description

I realized that subordinate nodes are not mentioned anywhere in the docs here. See: #5426.

Affected Pages/Sections

No response

Screenshots or Examples (if applicable)

No response

Suggested Fix

Consider documenting sub-nodes:

  1. Explain the concept of sub-nodes in the node concepts page: https://docs.ros.org/en/rolling/Concepts/Basic/About-Nodes.html
    • This might be too advanced for this basic concepts page, though
  2. Explain why/in what situations sub-nodes might be useful and show how they're used in a tutorial or how-to guide
  3. Find where it would make sense to link to these new concepts/tutorials pages

Additional Context

The best documentation we have right now for sub-nodes is the rclcpp::Node::create_sub_node() documentation: https://docs.ros.org/en/rolling/p/rclcpp/generated/classrclcpp_1_1Node.html#classrclcpp_1_1Node_1a8d5b012d7366795fbc8bb315be13a51b

See the original PR: ros2/rclcpp#581. It's interesting to note that it comes from wanting to add a "NodeHandle"-like concept like ROS 1 had: ros2/rclcpp#531.

@SuperGops7
Copy link
Contributor

Hey @christophebedard I can help with this issue

@fujitatomoya
Copy link
Collaborator

@SuperGops7 all yours, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants