-
Notifications
You must be signed in to change notification settings - Fork 67
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
Include node namespaces in get_node_names() #148
Conversation
@@ -473,7 +473,8 @@ RMW_WARN_UNUSED | |||
rmw_ret_t | |||
rmw_get_node_names( | |||
const rmw_node_t * node, | |||
rcutils_string_array_t * node_names); | |||
rcutils_string_array_t * node_names, | |||
rcutils_string_array_t * node_namespaces); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the signature becoming more complicated can you please add a docblock to document the semantic of these arguments.
rmw/include/rmw/rmw.h
Outdated
/** | ||
* This function will return a list of node names and a list of node namespaces | ||
* that are discovered via the middleware. The list of names and namespaces | ||
* will be the same length. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While kind of obvious maybe the doc should be explicit that these two lists represent pairs of namespace and name for each node.
@@ -468,12 +468,40 @@ rmw_wait( | |||
rmw_wait_set_t * wait_set, | |||
const rmw_time_t * wait_timeout); | |||
|
|||
/// Return a list of node name and namespaces discovered via a node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: either node names and namespaces
or node name and namespace pairs
?
3992257
to
1292dd2
Compare
I fixed the new warnings in |
* Include node namespaces in get_node_names(). * Update documentation for get_node_names. * Refinement/clarification of documentation. * wrap after sentence Signed-off-by: Devin Bonnie <dbbonnie@amazon.com>
Connects to #142