Skip to content

Commit c66d7e1

Browse files
committed
Clarified the overwrite_permitted parameter.
1 parent def5755 commit c66d7e1

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

api/swimos_agent_protocol/src/model.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,8 @@ impl<S, T> AdHocCommand<S, T> {
159159
/// * `command` - The body of the command message.
160160
/// * `overwrite_permitted` - Controls the behaviour of command handling in the case of back-pressure.
161161
/// If this is true, the command maybe be overwritten by a subsequent command to the same target (and so
162-
/// will never be sent). If false, the command will be queued instead.
162+
/// will never be sent). If false, the command will be queued instead. This is a user specifiable parameter
163+
/// in the API.
163164
pub fn new(address: Address<S>, command: T, overwrite_permitted: bool) -> Self {
164165
AdHocCommand {
165166
address,

0 commit comments

Comments
 (0)