chore: example to Lesser struct

aws · Oct 3, 2023 · f4e66b0 · f4e66b0
1 parent 17fcd6d
commit f4e66b0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/internal/pkg/queue/queue.go b/internal/pkg/queue/queue.go
@@ -7,6 +7,11 @@ package queue
 import "container/heap"
 
 // Lesser is an interface to enable generic structs to be elements of a priority queue.
+// Any struct can become a priority queue element by defining the LessThan method
+// and initializing a new PriorityQueue.
+//
+//		(s myStruct) LessThan(other myStruct) bool
+//	 q := NewPriorityQueue[myStruct]()
 type Lesser[T any] interface {
 	LessThan(T) bool
 }