docs: updated multiple doc comments

Author: adrianbrad

.github/dependabot.yaml

@@ -13,17 +13,6 @@ updates:
 
   - package-ecosystem: github-actions
     directory: "/"
-    schedule:
-      interval: weekly
-      day: "monday"
-      time: "06:00" # 9 am in romania
-    commit-message:
-      prefix: "build(deps)"
-    reviewers:
-      - "adrianbrad"
-
-  - package-ecosystem: docker
-    directory: "/d8t"
     schedule:
       interval: weekly
       day: "monday"

.github/workflows/codeql.yaml

@@ -1,9 +1,4 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-name: "CodeQL"
+name: codeql
 
 on:
   push:
@@ -34,6 +29,7 @@ jobs:
         uses: github/codeql-action/init@v2
         with:
           languages: go
+
       - name: Autobuild
         uses: github/codeql-action/autobuild@v2
 

Makefile

@@ -2,7 +2,7 @@ lint:
 	golangci-lint run --fix
 
 test:
-	go test -mod=mod -shuffle=on --race .
+	go test -mod=mod -shuffle=on -race .
 
 test-ci:
-	go test -mod=mod -shuffle=on -count=1 -timeout 60s  -coverprofile=coverage.txt -covermode=atomic .
+	go test -mod=mod -shuffle=on -race -timeout 60s -coverprofile=coverage.txt -covermode=atomic .

circular.go

@@ -10,6 +10,14 @@ var _ Queue[any] = (*Circular[any])(nil)
 // Circular is a Queue implementation.
 // A circular queue is a queue that uses a fixed-size slice as if it were connected end-to-end.
 // When the queue is full, adding a new element to the queue overwrites the oldest element.
+//
+// Example:
+// We have the following queue with a capacity of 3 elements: [1, 2, 3].
+// If the tail of the queue is set to 0, as if we just added the element `3`,
+// then the next element to be added to the queue will overwrite the element at index 0.
+// So, if we add the element `4`, the queue will look like this: [4, 2, 3].
+// If the head of the queue is set to 0, as if we never removed an element yet,
+// then the next element to be removed from the queue will be the element at index 0, which is `4`.
 type Circular[T comparable] struct {
 	initialElements []T
 	elems           []T
@@ -206,7 +214,7 @@ func (q *Circular[T]) Size() int {
 
 // ===================================Helpers==================================
 
-// Get returns the element at the head of the queue.
+// get returns the element at the head of the queue.
 func (q *Circular[T]) get() (v T, _ error) {
 	if q.isEmpty() {
 		return v, ErrNoElementsAvailable
@@ -219,6 +227,7 @@ func (q *Circular[T]) get() (v T, _ error) {
 	return item, nil
 }
 
+// isEmpty returns true if the queue is empty.
 func (q *Circular[T]) isEmpty() bool {
 	return q.size == 0
 }

doc.go

@@ -8,4 +8,8 @@
 // A priority queue based on a container.Heap. The elements in the queue
 // must implement the Lesser interface, and are ordered based on the
 // Less method. The head of the queue is always the highest priority element.
+//
+// A circular queue, which is a queue that uses a fixed-size slice as
+// if it were connected end-to-end. When the queue is full, adding a new element to the queue
+// overwrites the oldest element.
 package queue

queue_interface.go

@@ -1,6 +1,9 @@
 package queue
 
-// Queue is a collection that orders elements in a FIFO order.
+// A Queue is an ordered sequence of items, the order is usually first in first out.
+// New items are added to the back of the queue and
+// existing items are removed from the front of the queue.
+//
 // This interface provides basic methods for adding and extracting elements
 // from the queue.
 // Items are extracted from the head of the queue and added to the tail