clarify _include use case

john30 · john30 · commit 23a460b8fe1c · 2026-02-01T10:31:22.000+01:00
diff --git a/guidelines.md b/guidelines.md
@@ -108,8 +108,9 @@ import "./hwcmode_inc.tsp";  // <= imports the `Hwcmode_inc` namespace for refer
 namespace Circuit {
   /** included parts */
   union _includes {
-    Hwcmode_inc,  // <= references the imported namespace and implicitly resolves to all contained models
-    named: Hwcmode_inc, // <= named entry emits a !load instruction instead
+    Hwcmode_inc, // <= unnamed entry inlines the referenced definition or emits an "!include" instruction (if includes is set in the emitter options)
+    _include: Hwcmode_inc, // <= entry with a name starting with "_include" explicitly emits an "!include" instruction
+    named: Hwcmode_inc, // <= named entry emits a !load instruction (if name does not start with "_include")
   }
 }
 ```

Original file line number	Diff line number	Diff line change
@@ -108,8 +108,9 @@ import "./hwcmode_inc.tsp"; // <= imports the `Hwcmode_inc` namespace for refer
`108`	`108`	`namespace Circuit {`
`109`	`109`	`/** included parts */`
`110`	`110`	`union _includes {`
`111`		`- Hwcmode_inc, // <= references the imported namespace and implicitly resolves to all contained models`
`112`		`- named: Hwcmode_inc, // <= named entry emits a !load instruction instead`
	`111`	`+ Hwcmode_inc, // <= unnamed entry inlines the referenced definition or emits an "!include" instruction (if includes is set in the emitter options)`
	`112`	`+ _include: Hwcmode_inc, // <= entry with a name starting with "_include" explicitly emits an "!include" instruction`
	`113`	`+ named: Hwcmode_inc, // <= named entry emits a !load instruction (if name does not start with "_include")`
`113`	`114`	`}`
`114`	`115`	`}`
`115`	`116`	```