From a3394b37599aefeaeb80f9f9fa386a1d42cfaab5 Mon Sep 17 00:00:00 2001
From: John Bauer <horatio@gmail.com>
Date: Sat, 27 Feb 2021 08:02:50 -0800
Subject: [PATCH] Add some comments

---
 better-air-filtering/control.lua | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/better-air-filtering/control.lua b/better-air-filtering/control.lua
index 9d6f078..8a6ab5f 100644
--- a/better-air-filtering/control.lua
+++ b/better-air-filtering/control.lua
@@ -413,6 +413,9 @@ function FilteredChunk:addFilter(filter)
     end
 end
 
+-- Remove a filter machine from its chunk
+-- If this is removing the last filter, the record
+-- for this chunk is dropped.
 function FilteredChunk:removeFilter(filter)
     for i, f in pairs(self.filters) do
         if f.unit_number == filter.unit_number then
@@ -425,6 +428,9 @@ function FilteredChunk:removeFilter(filter)
     end
 end
 
+-- either return an existing FilteredChunk for the given coordinates,
+-- or create a new one at the corresponding coordinates if there are
+-- no existing filters on this chunk
 function getFilteredChunk(surface, x, y)
     local chunkListX = global.air_filtered_chunks_map[surface.name]
     if chunkListX ~= nil then
@@ -449,6 +455,8 @@ function isAirFilterMachine(entity)
     return starts_with(entity.name, "air-filter-machine-")
 end
 
+-- when a new machine is created, add it to the list of filters
+-- on whichever chunk it is on
 function onEntityCreated(event)
     if isAirFilterMachine(event.created_entity) then
         local chunkPos = positionToChunk(event.created_entity.position)