Skip to content

Commit 4ff94e2

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

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

rclrs/src/qos.rs

+6-3
Original file line numberDiff line numberDiff line change
@@ -286,9 +286,12 @@ impl QoSProfile {
286286
QOS_PROFILE_PARAMETER_EVENTS
287287
}
288288

289-
/// Get the system-defined default quality of service profile. This profile
290-
/// is determined by the underlying RMW implementation, so you cannot rely
291-
/// on this profile being consistent or appropriate for your needs.
289+
/// Get the system-defined default quality of service profile. Topics and
290+
/// services created with this default do not use the recommended ROS
291+
/// defaults; they will instead use the default as defined by the underlying
292+
/// RMW implementation (rmw_fastrtps, rmw_connextdds, etc). These defaults
293+
/// may not always be appropriate for every use-case, and may be different
294+
/// depending on which RMW implementation you are using, so use caution!
292295
pub fn system_default() -> Self {
293296
QOS_PROFILE_SYSTEM_DEFAULT
294297
}

0 commit comments

Comments
 (0)