Skip to content
This repository was archived by the owner on Feb 2, 2025. It is now read-only.

Commit 3635ee9

Browse files
author
Alex Belozierov
committed
- updated docs
1 parent 6bec15c commit 3635ee9

File tree

4 files changed

+5
-2
lines changed

4 files changed

+5
-2
lines changed

Sources/SwiftCoroutine/CoChannel/CoChannel.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public final class CoChannel<Element> {
4545
/// This channel has a buffer with unlimited capacity.
4646
///
4747
/// `awaitSend(_:)` to this channel never suspends, and offer always returns true.
48+
/// `awaitReceive()` suspends only when the buffer is empty.
4849
case unlimited
4950
/// This channel buffers at most one element and offer invocations,
5051
/// so that the receiver always gets the last element sent.

docs/Classes/CoChannel/BufferType.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,8 @@ <h4>Declaration</h4>
193193
<div class="abstract">
194194
<p>This channel has a buffer with unlimited capacity.</p>
195195

196-
<p><code><a href="../../Classes/CoChannel.html#/s:14SwiftCoroutine9CoChannelC9awaitSendyyxKF">awaitSend(_:)</a></code> to this channel never suspends, and offer always returns true.</p>
196+
<p><code><a href="../../Classes/CoChannel.html#/s:14SwiftCoroutine9CoChannelC9awaitSendyyxKF">awaitSend(_:)</a></code> to this channel never suspends, and offer always returns true.
197+
<code><a href="../../Classes/CoChannel.html#/s:14SwiftCoroutine9CoChannelC12awaitReceivexyKF">awaitReceive()</a></code> suspends only when the buffer is empty.</p>
197198

198199
</div>
199200
<div class="declaration">

docs/docsets/SwiftCoroutine.docset/Contents/Resources/Documents/Classes/CoChannel/BufferType.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,8 @@ <h4>Declaration</h4>
193193
<div class="abstract">
194194
<p>This channel has a buffer with unlimited capacity.</p>
195195

196-
<p><code><a href="../../Classes/CoChannel.html#/s:14SwiftCoroutine9CoChannelC9awaitSendyyxKF">awaitSend(_:)</a></code> to this channel never suspends, and offer always returns true.</p>
196+
<p><code><a href="../../Classes/CoChannel.html#/s:14SwiftCoroutine9CoChannelC9awaitSendyyxKF">awaitSend(_:)</a></code> to this channel never suspends, and offer always returns true.
197+
<code><a href="../../Classes/CoChannel.html#/s:14SwiftCoroutine9CoChannelC12awaitReceivexyKF">awaitReceive()</a></code> suspends only when the buffer is empty.</p>
197198

198199
</div>
199200
<div class="declaration">

docs/docsets/SwiftCoroutine.tgz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)