From f228cbaf71d2d44c4e8ab5757e04962780deea76 Mon Sep 17 00:00:00 2001 From: Honza Dvorsky Date: Wed, 16 Oct 2024 09:55:57 +0200 Subject: [PATCH] Fix up doc comments --- .../OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Sources/OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift b/Sources/OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift index ff374b39..aff0b9a1 100644 --- a/Sources/OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift +++ b/Sources/OpenAPIRuntime/EventStreams/ServerSentEventsDecoding.swift @@ -29,7 +29,6 @@ where Upstream.Element == ArraySlice { private let upstream: Upstream /// A closure that determines whether the given byte chunk should be forwarded to the consumer. - /// - Parameter: A byte chunk. /// - Returns: `true` if the byte chunk should be forwarded, `false` if this byte chunk is the terminating sequence. private let predicate: @Sendable (ArraySlice) -> Bool @@ -98,7 +97,7 @@ extension AsyncSequence where Element == ArraySlice, Self: Sendable { /// Returns another sequence that decodes each event's data as the provided type using the provided decoder. /// /// Use this method if the event's `data` field is not JSON, or if you don't want to parse it using `asDecodedServerSentEventsWithJSONData`. - /// - Parameter: A closure that determines whether the given byte chunk should be forwarded to the consumer. + /// - Parameter predicate: A closure that determines whether the given byte chunk should be forwarded to the consumer. /// - Returns: A sequence that provides the events. public func asDecodedServerSentEvents( while predicate: @escaping @Sendable (ArraySlice) -> Bool = { _ in true }