Improve doc comment

chipshort · webmaster128 · web-flow · commit 0dc2068fad69 · 2024-07-03T11:06:48.000+02:00
Co-authored-by: Simon Warta &lt;2603011+webmaster128@users.noreply.github.com&gt;
diff --git a/lib_libwasmvm.go b/lib_libwasmvm.go
@@ -112,7 +112,7 @@ func (vm *VM) GetMetrics() (*types.Metrics, error) {
 }
 
 // GetPinnedMetrics returns some internal metrics of pinned contracts for monitoring purposes.
-// The order of entries is non-deterministic.
+// The order of entries is non-deterministic and the values are node-specific. Don't use this in consensus-critical contexts.
 func (vm *VM) GetPinnedMetrics() (*types.PinnedMetrics, error) {
 	return api.GetPinnedMetrics(vm.cache)
 }

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ func (vm VM) GetMetrics() (types.Metrics, error) {`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`// GetPinnedMetrics returns some internal metrics of pinned contracts for monitoring purposes.`
`115`		`-// The order of entries is non-deterministic.`
	`115`	`+// The order of entries is non-deterministic and the values are node-specific. Don't use this in consensus-critical contexts.`
`116`	`116`	`func (vm VM) GetPinnedMetrics() (types.PinnedMetrics, error) {`
`117`	`117`	`return api.GetPinnedMetrics(vm.cache)`
`118`	`118`	`}`