From ca9010ae5fa2597c5cfe996e6fcdb55dc8750922 Mon Sep 17 00:00:00 2001
From: Martin Lange <44003176+mlange-42@users.noreply.github.com>
Date: Mon, 11 Nov 2024 12:39:53 +0100
Subject: [PATCH] Fix docstring for bitPool (#432)

---
 ecs/pool.go | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/ecs/pool.go b/ecs/pool.go
index 1317b3c1..c7ecd4c6 100644
--- a/ecs/pool.go
+++ b/ecs/pool.go
@@ -95,7 +95,9 @@ func (p *entityPool) Available() int {
 	return int(p.available)
 }
 
-// bitPool is an entityPool implementation using implicit linked lists.
+// bitPool is a pool of bits that makes it possible to obtain an un-set bit,
+// and to recycle that bit for later use.
+// This implementation uses an implicit list.
 type bitPool struct {
 	length    uint16
 	bits      [MaskTotalBits]uint8