Skip to content

Commit 9e2f368

Browse files
committed
Update scaladoc for Channnel
1 parent c55b21f commit 9e2f368

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

core/src/main/scala/ox/channels/Channel.scala

+4-3
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,10 @@ trait Sink[-T]:
221221
* - buffered channels, where a given number of sent values might be buffered, before subsequent `send`s block
222222
* - unlimited channels, where an unlimited number of values might be buffered, hence `send` never blocks
223223
*
224-
* Channels can be created using the channel's companion object. When no arguments are given, a rendezvous channel is created, while a
225-
* buffered channel can be created by providing a positive integer to the [[Channel.apply]] method. A rendezvous channel behaves like a
226-
* buffered channel with buffer size 0. An unlimited channel can be created using [[Channel.unlimited]].
224+
* Channels can be created using the channel's companion object. A rendezvous channel is created using [[Channel.rendezvous]]. A buffered
225+
* channel can be created either with a given capacity - by providing a positive integer to the [[Channel.buffered]] method - or with the
226+
* default capacity ([[StageCapacity.default]]) using [[Channel.bufferedDefault]] . A rendezvous channel behaves like a buffered channel
227+
* with buffer size 0. An unlimited channel can be created using [[Channel.unlimited]].
227228
*
228229
* In a rendezvous channel, senders and receivers block, until a matching party arrives (unless one is already waiting). Similarly,
229230
* buffered channels block if the buffer is full (in case of senders), or in case of receivers, if the buffer is empty and there are no

0 commit comments

Comments
 (0)