Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
gammazero committed Aug 4, 2023
1 parent 48475bd commit 145469d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion channelqueue_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ func TestRing(t *testing.T) {
}
}

func TestRingOne(t *testing.T) {
func TestOneRing(t *testing.T) {
ch := cq.NewRing[rune](1)
for _, r := range "hello" {
ch.In() <- r
Expand Down
11 changes: 5 additions & 6 deletions doc.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
// Package channelqueue implements a queue that uses channels for input and
// output to provide concurrent access to a re-sizable queue.
//
// This allows the queue to be used like a channel. Closing the input channel
// closes the output channel when all queued items are read, consistent with
// channel behavior. In other words channelqueue is a dynamically buffered
// channel with up to infinite capacity.
// output to provide concurrent access to a re-sizable queue. This allows the
// queue to be used like a channel. Closing the input channel closes the output
// channel when all queued items are read, consistent with channel behavior. In
// other words channelqueue is a dynamically buffered channel with up to
// infinite capacity.
//
// ChannelQueue also supports circular buffer behavior when created using
// `NewRing`. When the buffer is full, writing an additional item discards the
Expand Down

0 comments on commit 145469d

Please sign in to comment.