Amend rmw_destroy_subscription() documentation

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
ros2 · Aug 6, 2020 · e6620b0 · e6620b0
1 parent 003f485
commit e6620b0
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h
@@ -687,7 +687,8 @@ rmw_create_subscription(
  * or `RMW_RET_INCORRECT_RMW_IMPLEMENTATION`, ensues, leaving the given subscription handle
  * unchanged.
  * Otherwise, it will proceed despite errors, freeing as many resources as it can, including
- * the subscription handle. Usage of a deallocated subscription handle is undefined behavior.
+ * the subscription handle, and return `RMW_RET_ERROR`. Usage of a deallocated subscription
+ * handle is undefined behavior.
  *
  * \pre Given node must be the one the subscription was registered with.
  *