STYLE: Added note about module globals.
authorLukas Krickl <lukas@krickl.dev>
Mon, 2 Mar 2026 14:32:57 +0000 (15:32 +0100)
committerLukas Krickl <lukas@krickl.dev>
Mon, 2 Mar 2026 14:32:57 +0000 (15:32 +0100)
STYLE.md

index 2b3ea2623eb7f7dee9a80e313c951bb968d767c4..1dbe7c81c2074fced8a4a106cbfeab2d0285c784 100644 (file)
--- a/STYLE.md
+++ b/STYLE.md
@@ -18,6 +18,10 @@ Files and all functions therein are prefixed with one of the following:
 - `t_`: test case
 
 
+Modules often contain global structs that they need for internal processing.
+Generally the global structs should not be access from outside the module.
+In some rare cases this rule can be broken.
+
 ## Goto
 
 Goto is allowed for error handling or breaking out of nested loops.