Skip to content

Commit 5e656c3

Browse files
committed
Reword the warning for system_qos
Signed-off-by: Michael X. Grey <[email protected]>
1 parent d67f041 commit 5e656c3

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

rclrs/src/node/primitive_options.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,12 @@ pub trait IntoPrimitiveOptions<'a>: Sized {
8282
self.qos(QoSProfile::services_default())
8383
}
8484

85-
/// Use the system-defined default quality of service profile. This profile
86-
/// is determined by the underlying RMW implementation, so you cannot rely
87-
/// on this profile being consistent or appropriate for your needs.
85+
/// Use the system-defined default quality of service profile. Topics and
86+
/// services created with this default do not use the recommended ROS
87+
/// defaults; they will instead use the default as defined by the underlying
88+
/// RMW implementation (rmw_fastrtps, rmw_connextdds, etc). These defaults
89+
/// may not always be appropriate for every use-case, and may be different
90+
/// depending on which RMW implementation you are using, so use caution!
8891
fn system_qos(self) -> PrimitiveOptions<'a> {
8992
self.qos(QoSProfile::system_default())
9093
}

0 commit comments

Comments
 (0)