Skip to content

Clarify tutorial creates a new msg type #294

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.

Sign up for GitHub

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

Merged
ralph-lange merged 1 commit into from
Mar 22, 2021
Merged

Clarify tutorial creates a new msg type #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _docs/tutorials/core/create_new_type/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: How to create a new micro-ROS type
title: How to create a new micro-ROS message type
Comment thread
FranFin marked this conversation as resolved.
Comment thread
FranFin marked this conversation as resolved.
Copy link
Copy Markdown
Contributor

@FranFin FranFin Mar 16, 2021

Choose a reason for hiding this comment

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

Suggested change
title: How to create a new micro-ROS message type
title: How to add support for custom ROS message types to micro-ROS

Copy link
Copy Markdown
Member

@pablogs9 pablogs9 Mar 16, 2021

Choose a reason for hiding this comment

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

ok

Copy link
Copy Markdown
Contributor Author

@gavanderhoorn gavanderhoorn Mar 16, 2021

Choose a reason for hiding this comment

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

This seems similar to my suggestion, which @ralph-lange wasn't happy with.

Perhaps "Including a custom ROS message in micro-ROS"?

That doesn't imply special support is needed (although I believe with the way ROS 2 and micro-ROS work, it is actually almost like adding support), and does seem to communicate that those are the steps you'd need to get your own custom messages (or someone else's) included in your local micro-ROS build.

Copy link
Copy Markdown
Contributor

@ralph-lange ralph-lange Mar 16, 2021

Choose a reason for hiding this comment

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

I like you proposal, @gavanderhoorn! It is short, precise and already implies in the title that the procedure is similar to that for custom message types in normal ROS 2.

Copy link
Copy Markdown
Contributor Author

@gavanderhoorn gavanderhoorn Mar 16, 2021

Choose a reason for hiding this comment

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

Ok, so here it is as a suggestion:

Suggested change
title: How to create a new micro-ROS message type
title: Including a custom ROS message in micro-ROS

Copy link
Copy Markdown
Contributor Author

@gavanderhoorn gavanderhoorn Mar 16, 2021

Choose a reason for hiding this comment

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

Only thing is, it doesn't mention services nor actions, so I could see some users getting confused when reading this, but not sure we can help that other than making it clear in the tutorial text itself this is the procedure to follow for those as well.

Copy link
Copy Markdown
Member

@pablogs9 pablogs9 Mar 16, 2021

Choose a reason for hiding this comment

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

I'm ok with @gavanderhoorn suggestion. I assume that @ralph-lange also is. Please @FranFin commit and merge if you are ok.

permalink: /docs/tutorials/core/create_new_type/
---

Expand Down