From 601f412ea51e082d66192c317cb5eb7f2d7177a9 Mon Sep 17 00:00:00 2001 From: Konrad `ktoso` Malawski Date: Wed, 5 Apr 2023 16:50:35 +0900 Subject: [PATCH] [docs][Concurrency] Include required parameter in group docs [docs][Concurrency] Fix typo in method signature in code snippets of groups --- stdlib/public/Concurrency/DiscardingTaskGroup.swift | 6 +++--- stdlib/public/Concurrency/TaskGroup.cpp | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/stdlib/public/Concurrency/DiscardingTaskGroup.swift b/stdlib/public/Concurrency/DiscardingTaskGroup.swift index 049a5692afa36..f2764b08b1b63 100644 --- a/stdlib/public/Concurrency/DiscardingTaskGroup.swift +++ b/stdlib/public/Concurrency/DiscardingTaskGroup.swift @@ -35,7 +35,7 @@ import Swift /// before returning from this function: /// /// ``` -/// await withDiscardingTaskGroup { group in +/// await withDiscardingTaskGroup(...) { group in /// group.addTask { /* slow-task */ } /// // slow-task executes... /// } @@ -357,7 +357,7 @@ extension DiscardingTaskGroup: Sendable { } /// before returning from this function: /// /// ``` -/// try await withThrowingDiscardingTaskGroup { group in +/// try await withThrowingDiscardingTaskGroup(of: Void.self) { group in /// group.addTask { /* slow-task */ } /// // slow-task executes... /// } @@ -390,7 +390,7 @@ extension DiscardingTaskGroup: Sendable { } /// /// ``` /// // ThrowingTaskGroup, pattern not applicable to ThrowingDiscardingTaskGroup -/// try await withThrowingTaskGroup { group in +/// try await withThrowingTaskGroup(of: Void.self) { group in /// group.addTask { try boom() } /// try await group.next() // re-throws "boom" /// } diff --git a/stdlib/public/Concurrency/TaskGroup.cpp b/stdlib/public/Concurrency/TaskGroup.cpp index 1395dc10716ea..b17dd31a5a886 100644 --- a/stdlib/public/Concurrency/TaskGroup.cpp +++ b/stdlib/public/Concurrency/TaskGroup.cpp @@ -89,7 +89,7 @@ using FutureFragment = AsyncTask::FutureFragment; /// During evolution discussions we opted to implement the following semantic of /// a discarding task-group throw: -/// - the error thrown out of withThrowingDiscardingTaskGroup { ... } always "wins", +/// - the error thrown out of withThrowingDiscardingTaskGroup(...) { ... } always "wins", /// even if the group already had an error stored within. /// /// This is harder to implement, since we have to always store the "first error from children",