From 145b21ef3db24227d00dd4c7e04c8f91e2b66f12 Mon Sep 17 00:00:00 2001 From: aler9 <46489434+aler9@users.noreply.github.com> Date: Fri, 28 Oct 2022 14:11:58 +0200 Subject: [PATCH] update docs --- pkg/ringbuffer/ringbuffer.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/ringbuffer/ringbuffer.go b/pkg/ringbuffer/ringbuffer.go index 9289611a..8e9fb7ad 100644 --- a/pkg/ringbuffer/ringbuffer.go +++ b/pkg/ringbuffer/ringbuffer.go @@ -40,7 +40,7 @@ func (r *RingBuffer) Close() { r.event.signal() } -// Reset restores Pull() after a Close(). +// Reset restores Pull() behavior after a Close(). func (r *RingBuffer) Reset() { for i := uint64(0); i < r.size; i++ { atomic.SwapPointer(&r.buffer[i], nil) @@ -50,7 +50,7 @@ func (r *RingBuffer) Reset() { atomic.StoreInt64(&r.closed, 0) } -// Push pushes some data at the end of the buffer. +// Push pushes data at the end of the buffer. func (r *RingBuffer) Push(data interface{}) { writeIndex := atomic.AddUint64(&r.writeIndex, 1) i := writeIndex % r.size @@ -58,7 +58,7 @@ func (r *RingBuffer) Push(data interface{}) { r.event.signal() } -// Pull pulls some data from the beginning of the buffer. +// Pull pulls data from the beginning of the buffer. func (r *RingBuffer) Pull() (interface{}, bool) { for { i := r.readIndex % r.size