Clarify terminology: decl and type; clarify helpers' usage

1 files changed, 7 insertions, 0 deletions

diff --git a/cm/ex01.lua b/cm/ex01.lua
index 636ea2a..f92ec2a 100644
--- a/cm/ex01.lua
+++ b/cm/ex01.lua
@@ -1,6 +1,13 @@
 -- Environment is loaded with the utils (as metatable.__index)
 -- Global vars (aka properties on env) will be read as decls
 
+-- TERMINOLOGY:
+-- decl: a property somewhere, the property name and the value makes up the declaration
+-- type: a value (perhaps a part of a decl), which contains a type tag ("struct", "union", "alias", etc.) and extra info for that kind of type
+
+-- _struct, _union, _alias, etc. are type construction helpers.
+-- They take the essential info, and returns a value properly decorated. For example it might just add a property {_tag="struct"}, or perhaps more.
+
 -- name implied by property key here
 Bar = _struct({
     -- _t: Loads another type by its name. Return the type, or a placeholder if the type is not yet available