examples icon indicating copy to clipboard operation
examples copied to clipboard

improve names of executables and mention them in the readme

Open dirk-thomas opened this issue 8 years ago • 7 comments

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 for examples_rclcpp_minimal_client_main?

dirk-thomas avatar Dec 19 '16 19:12 dirk-thomas

Yeah I wasn't sure how else to make sure they didn't collide with other binaries when they are installed to the global bin directory, so I put that long ugly prefix on them.

The idea for the _main suffix for examples_rclcpp_minimal_client_main is because it has a main() function, and at some point (e.g., Beta 2) I'm hoping to add more examples that do not have a main() but instead use the forthcoming handy macros and generic launcher to allow easy component-style coding.

codebot avatar Dec 19 '16 20:12 codebot

These executables are now installed to libexec and renamed. The readme's dont refer to it yet so this is only documentation

mikaelarguedas avatar Feb 22 '18 19:02 mikaelarguedas

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 avatar Jan 24 '19 02:01 davetcoleman

@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.

The actions README should link back to its tutorial, if one exists. Perhaps that is where "composable" is defined?

Currently, a tutorial does not exist, but I think it's a good idea to link to a tutorial once it does.

jacobperron avatar Jan 25 '19 01:01 jacobperron

Thanks for the explanation.

Since there already exists a composition demo, I think that a different naming convention should be instated here.

You mean rename the source files, right? I don't understand all of this enough to provide input on that.

davetcoleman avatar Jan 25 '19 20:01 davetcoleman

You mean rename the source files, right?

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 Node, then the naming scheme here might be fine. If so, we should make sure to add "composable" examples for services and actions.

jacobperron avatar Jan 25 '19 22:01 jacobperron

I've submitted documentation as promised: https://github.com/ros2/examples/pull/224

davetcoleman avatar Jan 28 '19 16:01 davetcoleman