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]>
source/Tutorials/Beginner-Client-Libraries/Using-Parameters-In-A-Class-Python.rst
Outdated
Show resolved
Hide resolved
…-A-Class-Python.rst Co-authored-by: Christophe Bedard <[email protected]> Signed-off-by: sxzxyq <[email protected]>
Signed-off-by: sxzxyq <[email protected]>
Contributor
Author
|
Hi @christophebedard, thanks for the review! I've applied your suggestion and also removed the mention on line 57. The branch is up-to-date now. |
christophebedard
approved these changes
Oct 21, 2025
Member
christophebedard
left a comment
christophebedard
left a comment
There was a problem hiding this comment.
Looks good, thank you!
Member
|
@Mergifyio backport rolling kilted jazzy |
Contributor
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
Oct 21, 2025
…5958) Signed-off-by: sxzxyq <[email protected]> (cherry picked from commit ae7648e)
mergify bot
pushed a commit
that referenced
this pull request
Oct 21, 2025
…5958) Signed-off-by: sxzxyq <[email protected]> (cherry picked from commit ae7648e)
mergify bot
pushed a commit
that referenced
this pull request
Oct 21, 2025
…5958) Signed-off-by: sxzxyq <[email protected]> (cherry picked from commit ae7648e)
christophebedard
pushed a commit
that referenced
this pull request
Oct 21, 2025
…5958) (#5971) (cherry picked from commit ae7648e) Signed-off-by: sxzxyq <[email protected]> Co-authored-by: sxzxyq <[email protected]>
christophebedard
pushed a commit
that referenced
this pull request
Oct 21, 2025
…5958) (#5972) (cherry picked from commit ae7648e) Signed-off-by: sxzxyq <[email protected]> Co-authored-by: sxzxyq <[email protected]>
christophebedard
pushed a commit
that referenced
this pull request
Oct 21, 2025
…5958) (#5973) (cherry picked from commit ae7648e) Signed-off-by: sxzxyq <[email protected]> Co-authored-by: sxzxyq <[email protected]>
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