Package level README.md for common_msgs#12
Open
gavintranquilino wants to merge 2 commits intomainfrom
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a package-level README for the common_msgs package that documents its structure, purpose, usage guidelines for integration (via Dockerfiles, package.xml, CMakeLists.txt, and code imports), and testing instructions.
- New README to support adding and using additional message (.msg) files
- Documentation follows the Humanoid Documentation Format for consistency across the project
Comments suppressed due to low confidence (2)
autonomy/wato_msgs/common_msgs/README.md:21
- [nitpick] Consider reviewing the bullet list syntax used in the 'Inputs & Outputs' section; using the '-' character for bullets works in markdown but may be confused with diff markers. If possible, consider an alternative bullet symbol or formatting (such as '*' or indenting) to improve clarity for readers.
- **Outputs**: Provides `.msg` definitions that other ROS 2 packages can import and use.
autonomy/wato_msgs/common_msgs/README.md:25
- [nitpick] Similarly, in the 'Key Features' section, the use of '-' for bullet points might be mistaken for deletion markers in diff views. Consider using a consistent alternative bullet style to improve readability.
- **Message Definitions**: Contains a collection of `.msg` files, each defining a specific data structure. These messages are designed to be generic and applicable in multiple contexts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
.msgfiles to the common_msgs folder.