doc(BidrectionalSyncStream): add doc for method makeStream(of:)

rockmagma02 · Apr 21, 2024 · d7bef78 · d7bef78
1 parent 0b3d9a3
commit d7bef78
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Sources/SyncStream/BidirectionalSyncStream.swift b/Sources/SyncStream/BidirectionalSyncStream.swift
@@ -239,6 +239,10 @@ public extension BidirectionalSyncStream {
         }
     }
 
+    /// Constructs an Bidrectional synchronous stream from the Element Type
+    ///
+    /// - Returns: A tuple containing the stream and its continuation. The continuation
+    ///     should be passed to the producer while the stream should be passed to the consumer.
     static func makeStream(
         _: YieldT.Type = YieldT.self,
         _: SendT.Type = SendT.self,