Skip to content

Add notification about the usage of <rclcpp/rclcpp.hpp>. - #7113

Merged
ahcorde merged 4 commits into
rollingfrom
issues/7095
Aug 31, 2026
Merged

Add notification about the usage of <rclcpp/rclcpp.hpp>.#7113
ahcorde merged 4 commits into
rollingfrom
issues/7095

Conversation

@fujitatomoya

Copy link
Copy Markdown
Collaborator

Description

closes #7095

Fixes # (issue)

Did you use Generative AI?

Yes, Claude Fable 5

Additional Information

Signed-off-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Comment thread source/_internal/Rclcpp-Convenience-Header-Note.rst
@fujitatomoya fujitatomoya self-assigned this Aug 28, 2026
@fujitatomoya
fujitatomoya requested a review from kscottz August 28, 2026 03:28
@github-actions

github-actions Bot commented Aug 28, 2026

Copy link
Copy Markdown

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/33371416269/artifacts/9750360469.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-7113/index.html in your favorite browser

@kscottz kscottz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is beautiful. Thank you so much!

One minor suggestion but this is good to go as-is.

Comment thread source/_Rclcpp-Convenience-Header-Note.rst Outdated
Comment thread source/_internal/Rclcpp-Convenience-Header-Note.rst
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@ahcorde ahcorde added the backport-all backport at reviewers discretion; from rolling to all versions label Aug 31, 2026
@ahcorde
ahcorde merged commit e8142b2 into rolling Aug 31, 2026
6 checks passed
@ahcorde
ahcorde deleted the issues/7095 branch August 31, 2026 08:28
fujitatomoya added a commit that referenced this pull request Aug 31, 2026
(cherry picked from commit e8142b2)

Signed-off-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
fujitatomoya added a commit that referenced this pull request Aug 31, 2026
The mergify backport of #7113 assumed rolling's directory layout, where
the client-library tutorials were moved under
ROS-Framework/client-libraries/Working-with-Client-Libraries/. On kilted
those files still live at their older, shallower locations, so the
backport was broken in two ways:

- It re-added Single-Package-Define-And-Use-Interface.rst under the
  rolling-only path. That file already exists at How-To-Guides/ on this
  branch, so the copy was an orphan (not in any toctree) with dangling
  cross-references and failed the build. Removed it.

- Every ".. include::" of the convenience-header note used a relative
  path computed for rolling's deeper tree, so it overshot the source
  root on kilted and the note file could not be found (failing both the
  Sphinx build and doc8). Recomputed each include to the correct
  relative depth for its own location.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Tomoya.Fujita <fujita.tomoya@triorb.co.jp>
fujitatomoya added a commit that referenced this pull request Aug 31, 2026
The mergify backport of #7113 used ".. include::" paths for the
convenience-header note that were computed for rolling's directory
layout, where the client-library tutorials live one level deeper. On
humble those files are at shallower paths, so every include overshot the
source root and the note file could not be found, failing both the
Sphinx build and doc8.

Recomputed each include to the correct relative depth for its own
location so it resolves to
source/_internal/Rclcpp-Convenience-Header-Note.rst.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Tomoya.Fujita <fujita.tomoya@triorb.co.jp>
fujitatomoya added a commit that referenced this pull request Aug 31, 2026
The mergify backport of #7113 used ".. include::" paths for the
convenience-header note that were computed for rolling's directory
layout, where the client-library tutorials live one level deeper. On
jazzy those files are at shallower paths, so every include overshot the
source root and the note file could not be found, failing both the
Sphinx build and doc8.

Recomputed each include to the correct relative depth for its own
location so it resolves to
source/_internal/Rclcpp-Convenience-Header-Note.rst.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Tomoya.Fujita <fujita.tomoya@triorb.co.jp>
ahcorde pushed a commit that referenced this pull request Aug 31, 2026
) (#7144)

Signed-off-by: Tomoya.Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
ahcorde pushed a commit that referenced this pull request Aug 31, 2026
) (#7145)

Signed-off-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: Tomoya.Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
ahcorde pushed a commit that referenced this pull request Aug 31, 2026
) (#7146)

Signed-off-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: Tomoya.Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Tomoya Fujita <fujita.tomoya@triorb.co.jp>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-all backport at reviewers discretion; from rolling to all versions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 Update C++ Tutorials to Caveat Use of #include <rclcpp/rclcpp.hpp>

4 participants