-
Notifications
You must be signed in to change notification settings - Fork 315
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
improve names of executables and mention them in the readme #160
Comments
Yeah I wasn't sure how else to make sure they didn't collide with other binaries when they are installed to the global The idea for the |
These executables are now installed to libexec and renamed. The readme's dont refer to it yet so this is only documentation |
I would also appreciate an explanation of the term "not_composable" in the actionlib example, perhaps inside the file or in the README. The actions README should link back to its tutorial, if one exists. Perhaps that is where "composable" is defined? I'll PR it myself if someone could explain it to me. |
@davetcoleman My understanding is "composable" refers to the ability for a node to be used as part of a Composition (running multiple nodes in a single process). The Action examples followed the naming convention from the minimal publisher and minimal subscriber examples. But, the executables that are not labeled as "not composable" are not composable either (not shared libraries)... Since there already exists a composition demo, I think that a different naming convention should be instated here.
Currently, a tutorial does not exist, but I think it's a good idea to link to a tutorial once it does. |
Thanks for the explanation.
You mean rename the source files, right? I don't understand all of this enough to provide input on that. |
Yeah, the source files and executables. It looks like the README's for minimal_publisher and minimal_subscriber have explanations of "composable", so at the very least a similar description can be added to the action and service examples. Perhaps I'm mistaken about the meaning of "composable" here, if all it means is subclassing from |
I've submitted documentation as promised: #224 |
Currently the names are only discoverable by using the shell completion if you know that they start with
examples_rclcpp_minimal_
. They are not mentioned anywhere in the README files.Also why having the suffix
_main
forexamples_rclcpp_minimal_client_main
?The text was updated successfully, but these errors were encountered: