Skip to content

Commit 5c687ef

Browse files
paulhdkczechboy0
andauthored
Update doc comments in Sources/OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift
Co-authored-by: Honza Dvorsky <honza@apple.com>
1 parent 47ec7d1 commit 5c687ef

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Sources/OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ where Upstream.Element == ArraySlice<UInt8> {
2828
/// The upstream sequence.
2929
private let upstream: Upstream
3030

31-
/// A closure that determines whether the given byte sequence is the terminating byte sequence defined by the API.
31+
/// A closure that determines whether the given byte chunk should be forwarded to the consumer.
3232
/// - Parameter: A byte chunk.
33-
/// - Returns: `True` until the terminating byte sequence is received.
33+
/// - Returns: `true` if the byte chunk should be forwarded, `false` if this byte chunk is the terminating sequence.
3434
private let predicate: @Sendable (ArraySlice<UInt8>) -> Bool
3535

3636
/// Creates a new sequence.

0 commit comments

Comments
 (0)