Skip to content

Commit e7bcf5f

Browse files
committed
Fix channel docs
1 parent 39af184 commit e7bcf5f

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,7 @@ trait Sink[-T]:
177177
*/
178178
def error(reason: Throwable): Unit = errorOrClosed(reason).orThrow
179179

180-
/** Close the channel, indicating that no more values will be sent. Doesn't throw exceptions when the channel is closed, but returns a
181-
* value.
180+
/** Close the channel, indicating that no more values will be sent.
182181
*
183182
* Any values that are already buffered will be delivered. Any send operations that are in progress will complete normally, when a
184183
* receiver arrives. Any pending receive operations will complete with a channel closed result.
@@ -192,8 +191,7 @@ trait Sink[-T]:
192191
*/
193192
def doneOrClosed(): Unit | ChannelClosed = ChannelClosed.fromJoxOrUnit(delegate.doneOrClosed())
194193

195-
/** Close the channel, indicating that no more values will be sent. Doesn't throw exceptions when the channel is closed, but returns a
196-
* value.
194+
/** Close the channel, indicating that no more values will be sent.
197195
*
198196
* Any values that are already buffered will be delivered. Any send operations that are in progress will complete normally, when a
199197
* receiver arrives. Any pending receive operations will complete with a channel closed result.

0 commit comments

Comments
 (0)