worldedit: Document inner working of worldedit.keep_loaded

diff --git a/worldedit/common.lua b/worldedit/common.lua
index c62957f290953925ebea7e1dfafb5d4bef166c0a..9a2215ddc3ba45f55183fa22cf6e3c07947c64ce 100644 (file)
--- a/worldedit/common.lua
+++ b/worldedit/common.lua
@@ -46,6 +46,9 @@ end
 
 
 function worldedit.keep_loaded(pos1, pos2)
+       -- Create a vmanip and read the area from map, this
+       -- causes all MapBlocks to be loaded into memory.
+       -- This doesn't actually *keep* them loaded, unlike the name implies.
        local manip = minetest.get_voxel_manip()
        manip:read_from_map(pos1, pos2)
 end