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

docs: fix typo in tutorials/message_generation.md #494

Merged
merged 1 commit into from
Mar 7, 2025

Conversation

anshium
Copy link

@anshium anshium commented Mar 7, 2025

Corrected "restrctions" to "restrictions" and "entrypoint" to "entry point" in the documentation.

🦟 Bug fix

Fixes #493

Summary

Iterated through all the .md and .md.in files. Found 2 typos in the tutorials/message_generation.md file.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

@anshium anshium requested a review from caguero as a code owner March 7, 2025 06:44
@@ -85,7 +85,7 @@ For each file:

* `gz_msgs_protoc` accepts the arguments necessary to find all the supporting
scripts and executables:
* `gz_msgs_generate.py` - Top-level python script entrypoint for generating messages.
* `gz_msgs_generate.py` - Top-level python script entry point for generating messages.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would say entrypoint is valid. It's an alternative form of entry point. Do you mind to restore this change ?

@@ -85,7 +85,7 @@ For each file:

* `gz_msgs_protoc` accepts the arguments necessary to find all the supporting
scripts and executables:
* `gz_msgs_generate.py` - Top-level python script entrypoint for generating messages.
* `gz_msgs_generate.py` - Top-level python script entry point for generating messages.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `gz_msgs_generate.py` - Top-level python script entry point for generating messages.
* `gz_msgs_generate.py` - Top-level python script entrypoint for generating messages.

@anshium
Copy link
Author

anshium commented Mar 7, 2025

Got it. I have updated it.

Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

Do you mind to sign the commits ?

Corrected "restrctions" to "restrictions" in the documentation.

Signed-off-by: anshium <[email protected]>
@anshium
Copy link
Author

anshium commented Mar 7, 2025

I am sorry, I followed an incorrect procedure while signing. My commits had the Signed-off-by: message but not with a valid key. Fixed now.

Copy link
Collaborator

@caguero caguero left a comment

Choose a reason for hiding this comment

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

Thanks! Could you also check other md and md.in files? I believe there are spell issues in other files as well.

@anshium
Copy link
Author

anshium commented Mar 7, 2025

I did iterate through other files and ran aspell for each of them again. Could not find any other typos though. Not sure if I am missing something.

Checked for typos in:

gz-msgs/Migration.md
gz-msgs/Changelog.md
gz-msgs/examples/using_gz_msgs/README.md
gz-msgs/examples/generating_custom_msgs/README.md
gz-msgs/build/tutorials.md
gz-msgs/build/api.md
gz-msgs/tutorials/cppgetstarted.md
gz-msgs/tutorials/message_generation.md
gz-msgs/tutorials/install.md
gz-msgs/test/gtest_vendor/include/gtest/internal/custom/README.md
gz-msgs/CONTRIBUTING.md
gz-msgs/README.md
gz-msgs/api.md.in
gz-msgs/tutorials.md.in

@ahcorde
Copy link
Contributor

ahcorde commented Mar 7, 2025

feel free to open another PR if you find more typos. Thank you for your contribution

@ahcorde ahcorde merged commit 43a9274 into gazebosim:main Mar 7, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants