Skip to content

Commit

Permalink
Task: Remove inaccurate docs (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
dafurman authored Nov 26, 2024
1 parent e96a8a7 commit 7ffd52c
Showing 1 changed file with 0 additions and 4 deletions.
4 changes: 0 additions & 4 deletions Sources/ConcurrencyExtras/Task.swift
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ extension Task where Success == Never, Failure == Never {
/// [this Swift Forums post](https://forums.swift.org/t/reliably-testing-code-that-adopts-swift-concurrency/57304).
/// You may, however, prefer to use ``withMainSerialExecutor(operation:)-79jpc`` to improve the
/// reliability of async tests, and to make their execution deterministic.
///
/// > Note: When invoked from ``withMainSerialExecutor(operation:)-79jpc``, or when
/// > ``uncheckedUseMainSerialExecutor`` is set to `true`, `Task.megaYield()` is equivalent to
/// > a single `Task.yield()`.
public static func megaYield(count: Int = _defaultMegaYieldCount) async {
// TODO: Investigate why mega yields are still necessary in TCA's test suite.
// guard !uncheckedUseMainSerialExecutor else {
Expand Down

0 comments on commit 7ffd52c

Please sign in to comment.