From 51111f707f8a8a9f21defa1784bb0d2d8540f4b7 Mon Sep 17 00:00:00 2001
From: Mikayla Fischler <mikayla@ky8.io>
Date: Thu, 26 May 2022 19:37:19 -0400
Subject: [PATCH] more descriptive comments

---
 scada-common/comms.lua | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/scada-common/comms.lua b/scada-common/comms.lua
index c305b29..775127f 100644
--- a/scada-common/comms.lua
+++ b/scada-common/comms.lua
@@ -205,7 +205,7 @@ comms.modbus_packet = function ()
     -- get raw to send
     public.raw_sendable = function () return self.raw end
 
-    -- get this packet
+    -- get this packet as a frame with an immutable relation to this object
     public.get = function ()
         ---@class modbus_frame
         local frame = {
@@ -298,7 +298,7 @@ comms.rplc_packet = function ()
     -- get raw to send
     public.raw_sendable = function () return self.raw end
 
-    -- get this packet
+    -- get this packet as a frame with an immutable relation to this object
     public.get = function ()
         ---@class rplc_frame
         local frame = {
@@ -382,7 +382,7 @@ comms.mgmt_packet = function ()
     -- get raw to send
     public.raw_sendable = function () return self.raw end
 
-    -- get this packet
+    -- get this packet as a frame with an immutable relation to this object
     public.get = function ()
         ---@class mgmt_frame
         local frame = {
@@ -463,7 +463,7 @@ comms.coord_packet = function ()
     -- get raw to send
     public.raw_sendable = function () return self.raw end
 
-    -- get this packet
+    -- get this packet as a frame with an immutable relation to this object
     public.get = function ()
         ---@class coord_frame
         local frame = {
@@ -544,7 +544,7 @@ comms.capi_packet = function ()
     -- get raw to send
     public.raw_sendable = function () return self.raw end
 
-    -- get this packet
+    -- get this packet as a frame with an immutable relation to this object
     public.get = function ()
         ---@class capi_frame
         local frame = {