Added godoc to hero pool constr

Build-Squad · Jul 31, 2023 · ae190fc · ae190fc
1 parent 87599c8
commit ae190fc
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/module/mempool/herocache/backdata/heropool/pool.go b/module/mempool/herocache/backdata/heropool/pool.go
@@ -70,6 +70,8 @@ type Pool struct {
 	ejectionMode EjectionMode
 }
 
+// NewHeroPool returns a pointer to a new hero pool constructed based on a provided EjectionMode,
+// logger and a provided fixed size.
 func NewHeroPool(sizeLimit uint32, ejectionMode EjectionMode, logger zerolog.Logger) *Pool {
 	l := &Pool{
 		free: state{

diff --git a/module/mempool/herocache/backdata/heropool/pool_test.go b/module/mempool/herocache/backdata/heropool/pool_test.go
@@ -264,7 +264,7 @@ func testAddRemoveEntities(t *testing.T, limit uint32, entityCount uint32, eject
 
 	randomIntN := func(length int) int {
 		random, err := rand.Uintn(uint(length))
-		require.Nil(t, err)
+		require.NoError(t, err)
 		return int(random)
 	}