Add warning that actions require ament_cmake, not ament_python #4986 #5201
Conversation
|
@Yadunund please check this |
There was a problem hiding this comment.
Thanks a lot for the valuable improvement to our documentation.
Apart from the comments inline, I recommend updating the instructions to create the package to specify that ament_cmake should be the build_type.
ros2 pkg create --license Apache-2.0 --build_type ament_cmake custom_action_interfaces
| Actions can only be created in a C++ package using ``ament_cmake``. They are not supported in Python packages using ``ament_python``. This restriction also applies to messages and services, so ensure your package is configured as a C++ package before proceeding with this tutorial. | ||
|
|
There was a problem hiding this comment.
| Actions can only be created in a C++ package using ``ament_cmake``. They are not supported in Python packages using ``ament_python``. This restriction also applies to messages and services, so ensure your package is configured as a C++ package before proceeding with this tutorial. | |
| Interfaces for Actions (along with Message and Service) can only be generated by a package which has ``ament_cmake`` as its ``build_type``. | |
| It is recommended to define action interfaces (as well as messages and services) in a separate package dedicated to interfaces, as shown in this tutorial. This improves modularity and makes it easier to reuse them across multiple projects. | ||
|
|
There was a problem hiding this comment.
I suggest to move these two statements above the warning and outside the note block (ie, standalone statements) right after the Creating an interface package header.
|
Looks like @Yadunund and @fujitatomoya's suggestions are sufficient. I do want to point out that it helps us a lot if you can include a one or two sentence description of your pull request. I just approved #5050 which should make #4985 a lot easier. Once you wrap up this PR you are more than welcome to give that one a try once you read my comment there. |
|
@vimal0athithan friendly ping. Can you accepted the suggestions and make the necessary changes please so we can get this out the door? |
… and simplified line 48
|
@kscottz @Yadunund @fujitatomoya I have applied the suggested changes. Please review the updated version. |
|
@kscottz Thank you for the ping! I apologize for always contributing late always —I'm a university student, and my exams are currently ongoing, which has affected my availability. I’ve accepted the suggestions and made the necessary changes as requested. Please review the updates. Sorry again for the delay! |
There was a problem hiding this comment.
I do not think suggested fixes are applied.
besides, github action test failing, can you check and test local environment with https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html?
| @@ -41,6 +41,14 @@ Tasks | |||
| 1 Creating an interface package | |||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |||
|
|
|||
| Actions can only be created in a C++ package using ``ament_cmake``. They are not supported | |||
There was a problem hiding this comment.
I do not think this is true. it does not have to be C++ package, rather it has to be CMake package.
There was a problem hiding this comment.
@vimal0athithan I sent you some suggestions to fix your linter problems. Our linter is extra picky unfortunately.
Please accept these changes, address Tomoya's comment and we can get you merged.
|
@kscottz @Yadunund @fujitatomoya, I’ve pushed updates to fix the linting and test failures based on the check logs. Please review my new PR changes. Thank you! |
Signed-off-by: Katherine Scott <[email protected]>
Signed-off-by: Katherine Scott <[email protected]>
Signed-off-by: Katherine Scott <[email protected]>
|
@kscottz @Yadunund @fujitatomoya, I’ve fixed the trailing whitespace and missing newline issues. Please review again. Thanks! |
| For more detailed information about ROS actions, please refer to the `design article <http://design.ros2.org/articles/actions.html>`__. | ||
| For more detailed information about ROS actions, please refer to the `design article <https://design.ros2.org/articles/actions.html>`__. | ||
|
|
||
| [blank line] |
There was a problem hiding this comment.
what is this?
| [blank line] | |
| [blank line] |
|
@vimal0athithan can you hit the signoff / commit button on these? |
Co-authored-by: Christophe Bedard <[email protected]> Signed-off-by: Katherine Scott <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]> Signed-off-by: Katherine Scott <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: Katherine Scott <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: Katherine Scott <[email protected]>
|
@vimal0athithan second ping. This is so close. |
No description provided.