Skip to content

Commit 81c7849

Browse files
authored
Update FlattenStrategy.throttle docs. (#770)
1 parent 21a1e99 commit 81c7849

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Sources/Flatten.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ public struct FlattenStrategy {
9898
/// stream of values.
9999
public static let race = FlattenStrategy(kind: .race)
100100

101-
/// Forward only events from the "first inner stream" that sends an event if not exists.
102-
/// Other inner streams is disposed of until the first inner stream is completed.
103-
/// Note that next inner stream after previous completion can become
104-
/// first inner stream again.
101+
/// Given a first inner stream, all subsequent inner streams sent by the upstream would
102+
/// be dropped until the first inner stream has completed. The whole process repeats
103+
/// indefinitely until the upstream terminates. The behavior is akin to `throttle(_:on:)`
104+
/// except for operating in the domain of streams instead of time.
105105
///
106106
/// The flattened stream of values completes only when the stream of streams has completed,
107107
/// and first inner stream has completed if exists.

0 commit comments

Comments
 (0)