Document unsafeTryInstallSingletonPosixEventLoopGroupAsConcurrencyGlo…

…balExecutor (#2721) Document what unsafeTryInstallSingletonPosixEventLoopGroupAsConcurrencyGlobalExecutor's return value means
apple · May 14, 2024 · 5c378ed · 5c378ed
1 parent cd51717
commit 5c378ed
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/Sources/NIOPosix/PosixSingletons+ConcurrencyTakeOver.swift b/Sources/NIOPosix/PosixSingletons+ConcurrencyTakeOver.swift
@@ -35,6 +35,8 @@ extension NIOSingletons {
     /// operation doesn't guarantee anything because another piece of code could have done the same without using atomic operations. But we
     /// do our best.
     ///
+    /// - returns: If ``MultiThreadedEventLoopGroup/singleton`` was successfully installed as Swift Concurrency's global executor or not.
+    ///
     /// - warning: You may only call this method from the main thread.
     /// - warning: You may only call this method once.
     @discardableResult