docs: Correct --dependencies description for ament_python packages #5958
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
The description for the `--dependencies` argument incorrectly included CMakeLists.txt when creating an ament_python package. This change clarifies that for ament_python packages, only package.xml is modified, preventing confusion for new users. Signed-off-by: sxzxyq <[email protected]>
| Your terminal will return a message verifying the creation of your package ``python_parameters`` and all its necessary files and folders. | ||
|
|
||
| The ``--dependencies`` argument will automatically add the necessary dependency lines to ``package.xml`` and ``CMakeLists.txt``. | ||
| The ``--dependencies`` argument will automatically add the necessary dependency lines to ``package.xml``. For ament_cmake packages, it would also update ``CMakeLists.txt``. |
There was a problem hiding this comment.
Thanks for the PR. Since this tutorial is specifically for Python, I would simply remove the mention of CMakeLists.txt. It's correctly mentioned in the C++ tutorial: https://docs.ros.org/en/rolling/Tutorials/Beginner-Client-Libraries/Using-Parameters-In-A-Class-CPP.html#create-a-package.
Suggested change
| The ``--dependencies`` argument will automatically add the necessary dependency lines to ``package.xml``. For ament_cmake packages, it would also update ``CMakeLists.txt``. | |
| The ``--dependencies`` argument will automatically add the necessary dependency lines to ``package.xml``. |
It's also mentioned on line 57 below; can you remove that one too?
Then I can port this to all other branches.
There was a problem hiding this comment.
lgtm with these fixes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
The description for the
--dependenciesargument incorrectly included CMakeLists.txt when creating an ament_python package. This change clarifies that for ament_python packages, only package.xml is modified, preventing confusion for new users.Did you use Generative AI?
No.
Additional Information
N/A