Skip to content

Commit 0d8bc49

Browse files
committed
Comments
Signed-off-by: Adam Fowler <[email protected]>
1 parent c895980 commit 0d8bc49

File tree

3 files changed

+27
-24
lines changed

3 files changed

+27
-24
lines changed

Sources/Valkey/Connection/ValkeyConnection.swift

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,9 @@ public final actor ValkeyConnection: ValkeyClientProtocol, Sendable {
248248
/// Another client will never be served in the middle of the execution of these
249249
/// commands. See https://valkey.io/topics/transactions/ for more information.
250250
///
251-
/// Once all the responses for the commands have been received the function returns
252-
/// a parameter pack of Results, one for each command.
251+
/// EXEC and MULTI commands are added to the pipelined commands and the output
252+
/// of the EXEC command is transformed into a parameter pack of Results, one
253+
/// for each command.
253254
///
254255
/// - Parameter commands: Parameter pack of ValkeyCommands
255256
/// - Returns: Parameter pack holding the responses of all the commands
@@ -288,13 +289,13 @@ public final actor ValkeyConnection: ValkeyClientProtocol, Sendable {
288289
/// Another client will never be served in the middle of the execution of these
289290
/// commands. See https://valkey.io/topics/transactions/ for more information.
290291
///
291-
/// Once all the responses for the commands have been received the function returns
292-
/// an array of RESPToken Results, one for each command.
292+
/// EXEC and MULTI commands are added to the pipelined commands and the output
293+
/// of the EXEC command is transformed into an array of RESPToken Results, one for
294+
/// each command.
293295
///
294-
/// This is an alternative version of the pipelining function ``ValkeyConnection/transaction(_:)->(_,_)``
295-
/// that allows for a collection of ValkeyCommands. It provides more flexibility but is
296-
/// slightly more expensive to run and the command responses are returned as ``RESPToken``
297-
/// instead of the response type for the command.
296+
/// This is an alternative version of the transaction function ``ValkeyConnection/transaction(_:)->(_,_)``
297+
/// that allows for a collection of ValkeyCommands. It provides more flexibility but the command
298+
/// responses are returned as ``RESPToken`` instead of the response type for the command.
298299
///
299300
/// - Parameter commands: Collection of ValkeyCommands
300301
/// - Returns: Array holding the RESPToken responses of all the commands

Sources/Valkey/Node/ValkeyNodeClient.swift

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,9 @@ extension ValkeyNodeClient {
188188
/// Another client will never be served in the middle of the execution of these
189189
/// commands. See https://valkey.io/topics/transactions/ for more information.
190190
///
191-
/// Once all the responses for the commands have been received the function returns
192-
/// a parameter pack of Results, one for each command.
191+
/// EXEC and MULTI commands are added to the pipelined commands and the output
192+
/// of the EXEC command is transformed into a parameter pack of Results, one
193+
/// for each command.
193194
///
194195
/// - Parameter commands: Parameter pack of ValkeyCommands
195196
/// - Returns: Parameter pack holding the responses of all the commands
@@ -207,13 +208,13 @@ extension ValkeyNodeClient {
207208
/// Another client will never be served in the middle of the execution of these
208209
/// commands. See https://valkey.io/topics/transactions/ for more information.
209210
///
210-
/// Once all the responses for the commands have been received the function returns
211-
/// an array of RESPToken Results, one for each command.
211+
/// EXEC and MULTI commands are added to the pipelined commands and the output
212+
/// of the EXEC command is transformed into an array of RESPToken Results, one for
213+
/// each command.
212214
///
213-
/// This is an alternative version of the pipelining function ``ValkeyNodeClient/transaction(_:)->(_,_)``
214-
/// that allows for a collection of ValkeyCommands. It provides more flexibility but is
215-
/// slightly more expensive to run and the command responses are returned as ``RESPToken``
216-
/// instead of the response type for the command.
215+
/// This is an alternative version of the transaction function ``ValkeyNodeClient/transaction(_:)->(_,_)``
216+
/// that allows for a collection of ValkeyCommands. It provides more flexibility but the command
217+
/// responses are returned as ``RESPToken`` instead of the response type for the command.
217218
///
218219
/// - Parameter commands: Collection of ValkeyCommands
219220
/// - Returns: Array holding the RESPToken responses of all the commands

Sources/Valkey/ValkeyClient.swift

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,9 @@ extension ValkeyClient {
222222
/// Another client will never be served in the middle of the execution of these
223223
/// commands. See https://valkey.io/topics/transactions/ for more information.
224224
///
225-
/// Once all the responses for the commands have been received the function returns
226-
/// a parameter pack of Results, one for each command.
225+
/// EXEC and MULTI commands are added to the pipelined commands and the output
226+
/// of the EXEC command is transformed into a parameter pack of Results, one
227+
/// for each command.
227228
///
228229
/// - Parameter commands: Parameter pack of ValkeyCommands
229230
/// - Returns: Parameter pack holding the responses of all the commands
@@ -239,13 +240,13 @@ extension ValkeyClient {
239240
/// Another client will never be served in the middle of the execution of these
240241
/// commands. See https://valkey.io/topics/transactions/ for more information.
241242
///
242-
/// Once all the responses for the commands have been received the function returns
243-
/// an array of RESPToken Results, one for each command.
243+
/// EXEC and MULTI commands are added to the pipelined commands and the output
244+
/// of the EXEC command is transformed into an array of RESPToken Results, one for
245+
/// each command.
244246
///
245-
/// This is an alternative version of the pipelining function ``ValkeyClient/transaction(_:)->(_,_)``
246-
/// that allows for a collection of ValkeyCommands. It provides more flexibility but is
247-
/// slightly more expensive to run and the command responses are returned as ``RESPToken``
248-
/// instead of the response type for the command.
247+
/// This is an alternative version of the transaction function ``ValkeyClient/transaction(_:)->(_,_)``
248+
/// that allows for a collection of ValkeyCommands. It provides more flexibility but the command
249+
/// responses are returned as ``RESPToken`` instead of the response type for the command.
249250
///
250251
/// - Parameter commands: Collection of ValkeyCommands
251252
/// - Returns: Array holding the RESPToken responses of all the commands

0 commit comments

Comments
 (0)