docs: add docs on component/entity removal

1 files changed, 7 insertions, 1 deletions

diff --git a/raccoon.lua b/raccoon.lua
index c0fec2f..df57514 100644
--- a/raccoon.lua
+++ b/raccoon.lua
@@ -191,7 +191,13 @@ function System:init(...)
     --- Run the system.
     -- @param entities array of entities.
     --
-    -- @note `system:exec(entity)` needs to be defined for a specific system.
+    -- @note a function `system:exec(entity)` needs to be defined for a
+    -- specific system. it can return a boolean guard `rm` and a list of
+    -- components `cmps`
+    --
+    --   rm \ cmps   nil                             { ... }
+    --   true        remove entity after processing  remove provided components after processing
+    --   false       do nothing after processing     do nothing after processing
     --
     -- @usage
     -- To run an instance `s` of a system `S`