Skip to content

Update page on custom interfaces#6312

Open
kacperbojakowski-3di wants to merge 7 commits into
ros2:rollingfrom
kacperbojakowski-3di:custom-interfaces-howto
Open

Update page on custom interfaces#6312
kacperbojakowski-3di wants to merge 7 commits into
ros2:rollingfrom
kacperbojakowski-3di:custom-interfaces-howto

Conversation

@kacperbojakowski-3di

@kacperbojakowski-3di kacperbojakowski-3di commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

Updated the article "Implementing custom interfaces - how to" as approved by Geoff and 3di.

Description

Related to: ros2/ros2#1725

Updated the custom interfaces how-to page by replacing the old single-package tutorial with the new revised tutorial, and updated the TOC to add the new page entry and remove/replace the old one (incl. the Beginner-Client-Libraries tutorial list).

Did you use Generative AI?

No.

Additional Information

Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.

Updated the article "Implementing custom interfaces - how to" as approved by Geoff and 3di.
@kscottz

kscottz commented Mar 25, 2026

Copy link
Copy Markdown
Collaborator

@kacperbojakowski-3di

You have some liner errors to address.

source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst:173: Each sentence must start on a new line. Break between "a." and "In your workspace" (sentence-count)
source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst:174: Each sentence must start on a new line. Break between "b." and "Source the workspace" (sentence-count)
source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst:213: Each sentence must start on a new line. Break between "c." and "Check the interface" (sentence-count)

@fujitatomoya fujitatomoya 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.

a couple of minor comments. thanks for making contribution.

Comment thread source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst
Comment thread source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst Outdated

@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 good and is pretty close to ready to go.

I would like to find a way to address my comment on line 32. I think an area where new users struggle is figuring out when and where to create a new message type. A lot of thought goes into our standard messages and I would hope that the our users put the same amount of care into creating their own message types. Migrating and updating in messages in ROS is a huge pain, and we really want users to be thoughtful about constructing their messages initially.

Comment thread source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst Outdated
Comment thread source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst
Comment thread source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst
Comment thread source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst
kacperbojakowski-3di and others added 5 commits May 6, 2026 01:35
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: Tully Foote <tully.foote@gmail.com>
@kacperbojakowski-3di

Copy link
Copy Markdown
Contributor Author

@kscottz Hi Kat, pinging you again on this one. This has been gathering dust for a while, so yesterday I merged in rolling plus made a tiny update, something I missed the previous time. Anyway, now CI is failing due to some unresolved rosdistro refs and unreachable intersphinx inventories. Not my doing obviously, came from upstream, but let me know if I should do anything about it. Thanks.

@kscottz

kscottz commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the friendly ping.

I'll need to see what's going on with the docs CI before we merge this. Unclear when the current issue was introduced. We may need you to do one quick rebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants