nit: added comment explaining function behavior

Signed-off-by: Ashish Naware <ashishnaware3@gmail.com>
cilium · Sep 17, 2024 · dc13ea6 · dc13ea6
1 parent 09fb765
commit dc13ea6
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/pkg/observer/cache.go b/pkg/observer/cache.go
@@ -15,9 +15,9 @@ type cache struct {
 	size  int
 }
 
-func newCache(
-	dataCacheSize int,
-) (*cache, error) {
+// newCache constructs a cache of fixed size with the callback function that increments
+// data_cache_evictions_total counter every time the cache is evicted.
+func newCache(dataCacheSize int) (*cache, error) {
 	lruCache, err := lru.NewWithEvict(
 		dataCacheSize,
 		func(_ dataapi.DataEventId, _ []byte) {