Minor: add comments to key fields of Resources

matnar · matnar · commit 9854c08d1845 · 2025-09-24T12:50:03.000+02:00
diff --git a/internal/node/node.go b/internal/node/node.go
@@ -33,9 +33,9 @@ type Resources struct {
 	sync.RWMutex
 	totalMemory     int64
 	totalCPUs       float64
-	busyPoolUsedMem int64
-	warmPoolUsedMem int64
-	usedCPUs        float64
+	busyPoolUsedMem int64   // amount of memory used by functions currently running
+	warmPoolUsedMem int64   // amount of memory used by warm containers
+	usedCPUs        float64 // number of CPU used by functions currently running
 	containerPools  map[string]*ContainerPool
 }
 
@@ -54,7 +54,7 @@ func (n *Resources) FreeMemory() int64 {
 	return n.totalMemory - n.busyPoolUsedMem - n.warmPoolUsedMem
 }
 
-// AvailableMemory returns amount of memory that is free or reclaimable from warm containers
+// AvailableMemory returns the amount of memory that is free or reclaimable from warm containers
 func (n *Resources) AvailableMemory() int64 {
 	return n.totalMemory - n.busyPoolUsedMem
 }

Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,9 @@ type Resources struct {`
`33`	`33`	`sync.RWMutex`
`34`	`34`	`totalMemory int64`
`35`	`35`	`totalCPUs float64`
`36`		`- busyPoolUsedMem int64`
`37`		`- warmPoolUsedMem int64`
`38`		`- usedCPUs float64`
	`36`	`+ busyPoolUsedMem int64 // amount of memory used by functions currently running`
	`37`	`+ warmPoolUsedMem int64 // amount of memory used by warm containers`
	`38`	`+ usedCPUs float64 // number of CPU used by functions currently running`
`39`	`39`	`containerPools map[string]*ContainerPool`
`40`	`40`	`}`
`41`	`41`
`@@ -54,7 +54,7 @@ func (n *Resources) FreeMemory() int64 {`
`54`	`54`	`return n.totalMemory - n.busyPoolUsedMem - n.warmPoolUsedMem`
`55`	`55`	`}`
`56`	`56`
`57`		`-// AvailableMemory returns amount of memory that is free or reclaimable from warm containers`
	`57`	`+// AvailableMemory returns the amount of memory that is free or reclaimable from warm containers`
`58`	`58`	`func (n *Resources) AvailableMemory() int64 {`
`59`	`59`	`return n.totalMemory - n.busyPoolUsedMem`
`60`	`60`	`}`