Add a note on use in ROS 2 in README.rst #372
Open
Conversation
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
nuclearsandwich
approved these changes
Sep 12, 2025
|
|
||
| Standalone Python library for the `Catkin package system <http://ros.org/wiki/catkin>`_. | ||
|
|
||
| > [!NOTE] |
There was a problem hiding this comment.
Suggested change
| > [!NOTE] | |
| > ℹ️ |
This syntax is a GitHub markdown extension and doesn't appear to render in restructured text.
I don't really love the use of non-standard Markdown extensions anyway. Could we use an emoji ℹ️ icon instead?
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.
I am not familiar with maintenance of ROS 2, and I was a bit confused by the user of
catkin_pkgin ROS 2 context (see for example https://docs.ros.org/en/rolling/How-To-Guides/Core-maintainer-guide.html#source-release), as I always associatedcatkinto ROS 1.However, from what I understand this is how things I done, so I added a note on this to the repo README to clarify this for non-expert users (like me). Feel free to bikeshed the exact wording or the location of this documentation (xref: #343).