record: add unpack method annotation

cockroachdb · Sep 14, 2024 · 51e08f0 · 51e08f0
1 parent 139ee80
commit 51e08f0
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/record/log_writer.go b/record/log_writer.go
@@ -84,11 +84,12 @@ type syncQueue struct {
 
 const dequeueBits = 32
 
+// unpack extracts the head and tail indices from a 64-bit unsigned integer.
 func (q *syncQueue) unpack(ptrs uint64) (head, tail uint32) {
  const mask = 1<<dequeueBits - 1
  head = uint32((ptrs >> dequeueBits) & mask)
  tail = uint32(ptrs & mask)
- return
+ return head, tail
 }
 
 func (q *syncQueue) push(wg *sync.WaitGroup, err *error) {