search

ros2 / design

Design documentation for ROS 2.0 effort
http://design.ros2.org/
Apache License 2.0
215 stars 194 forks source link

Add launch XML substitution for a packages share directory #254

Closed jacobperron closed 4 years ago

jacobperron commented 4 years ago

Rename find-pkg to find-pkg-prefix. Add find-pkg-share substitution for the share directory.

Implementation is in https://github.com/ros2/launch_ros/pull/57

jacobperron commented 4 years ago

Alternatively, we could re-use the name find-pkg to refer to the share directory, which I think is the more common case. See https://github.com/ros2/launch_ros/pull/57#issuecomment-525920400

Thoughts?

dirk-thomas commented 4 years ago

we could re-use the name find-pkg to refer to the share directory, which I think is the more common case.

Common or not my argument is that it is opaque to the user what it maps to. The user must read docs to understand its behavior which I think is not good naming.

wjwwood commented 4 years ago

I think they'll have to read the documentation (or infer its behavior from an example) anyways. I always prefer more explicit names, so I'm ok with find-pkg-share, but I know other people don't want to type that all the time and for the vast majority of the time when they say "find-pkg" they mean the share directory. So I'd also be ok with find-pkg as an alias to find-pkg-share.

ivanpauno commented 4 years ago

I prefer the explicit names find_pkg_prefix and find_pkg_share, as it is now.

jacobperron commented 4 years ago

Thanks for the feedback everyone! I'll proceed with explicit names (find-pkg-prefix and find-pkg-share) and we can always add the alias find-pkg in the future, if the community wants it.