From 0a75f0c2ed644d9d87164a8c7526d2a4ca35a270 Mon Sep 17 00:00:00 2001
From: Henrik Hautakoski <henrik.hautakoski@gmail.com>
Date: Mon, 28 Dec 2020 19:28:27 +0100
Subject: [PATCH] .bam/functions.lua: adding documentation to host_system()

---
 .bam/functions.lua | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.bam/functions.lua b/.bam/functions.lua
index 2a501b7..f04bfa3 100644
--- a/.bam/functions.lua
+++ b/.bam/functions.lua
@@ -31,10 +31,13 @@ function host_system()
 		return _systems[2]
 	end
 
+	-- next, check if we are on windows by checking
+	-- the 'OS' environment variable
 	local win = os.getenv('OS')
 	if win ~= nil and win:lower():match('windows') then
 		return _systems[1]
 	end
+
 	return nil
 end