Skip to content

Commit 42bb43b

Browse files
committed
Address more peer review comments.
Signed-off-by: Michel Hidalgo <[email protected]>
1 parent 6c83764 commit 42bb43b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

rmw/include/rmw/rmw.h

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,9 @@ rmw_get_serialization_format(void);
135135
* This function can fail, and therefore return `NULL`, if:
136136
* - name is not a valid non-null node name
137137
* - namespace is not a valid non-null namespace
138-
* - context is not valid i.e. it has been initialized
139-
* by `rmw_init()` but not yet invalidated by
138+
* - context is not valid i.e. it is zero-initialized, or
139+
* its implementation identifier does not match that of
140+
* this API implementation, or has been invalidated by
140141
* `rmw_shutdown()`
141142
* - memory allocation fails during node creation
142143
* - an unspecified error occurs
@@ -154,7 +155,7 @@ rmw_get_serialization_format(void);
154155
*
155156
* \param[in] context init context that this node should be associated with
156157
* \param[in] name the node name
157-
* \param[in] namespace_ the node namespace
158+
* \param[in] namespace the node namespace
158159
* \param[in] domain_id the id of the domain that the node should join
159160
* \param[in] localhost_only whenever to use loopback only for communication or
160161
* default network interfaces.
@@ -166,16 +167,17 @@ rmw_node_t *
166167
rmw_create_node(
167168
rmw_context_t * context,
168169
const char * name,
169-
const char * namespace_,
170+
const char * namespace,
170171
size_t domain_id,
171172
bool localhost_only);
172173

173174
/// Finalize a given node handle, reclaim the resources, and deallocate the node handle.
174175
/**
175176
* \pre All publishers, subscribers, services, and clients created from this node must
176-
* have been destroyed upon call. Some rmw implementations may choose to verify this,
177+
* have been destroyed prior to this call. Some rmw implementations may verify this,
177178
* returning `RMW_RET_ERROR` and setting a human readable error message if any entity
178-
* created from this node has not yet been destroyed.
179+
* created from this node has not yet been destroyed. However, this is not guaranteed
180+
* and so callers should ensure that this is the case before calling this function.
179181
*
180182
* \param[in] node the node handle to be destroyed
181183
* \return `RMW_RET_OK` if successful, or

0 commit comments

Comments
 (0)