Skip to content
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

Improve message generation tutorial and example #386

Merged
merged 5 commits into from
Sep 27, 2023

Conversation

mjcarroll
Copy link
Contributor

This expands the example, and adds some more documentation about how message generation works in a tutorial.

While there is some duplication between them, I think there is value in having the tutorial, as those are what gets indexed in the documentation as well as coverage in the tutorial party. I think there is value in having the example as that gets CI coverage.

Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Sep 25, 2023
Signed-off-by: Michael Carroll <mjcarroll@intrinsic.ai>
@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

Merging #386 (b6ece1e) into gz-msgs10 (a6fbd92) will not change coverage.
The diff coverage is n/a.

❗ Current head b6ece1e differs from pull request most recent head 2c79db3. Consider uploading reports for the commit 2c79db3 to get more accurate results

@@            Coverage Diff             @@
##           gz-msgs10     #386   +/-   ##
==========================================
  Coverage      97.26%   97.26%           
==========================================
  Files             27       27           
  Lines           1170     1170           
==========================================
  Hits            1138     1138           
  Misses            32       32           

@azeey azeey added the beta Targeting beta release of upcoming collection label Sep 26, 2023
@azeey
Copy link
Contributor

azeey commented Sep 27, 2023

I've added the new file to tutorials.md.in and made some changes so that images are rendered properly in 2c79db3

Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

LGTM!

tutorials/message_generation.md Show resolved Hide resolved
@mjcarroll mjcarroll merged commit a731933 into gz-msgs10 Sep 27, 2023
9 of 11 checks passed
@mjcarroll mjcarroll deleted the mjcarroll/messages_tutorial branch September 27, 2023 23:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta Targeting beta release of upcoming collection 🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants