comment about Net

src/lang/net/Net.ts

@@ -3,20 +3,21 @@ import { Port } from "../port"
 import { Sign } from "../sign"
 import { Value } from "../value"
 
-export type Connection = {
-  edge: Edge
-  port: Port
-}
+/*
 
-export type PortEntry = {
-  name: string
-  sign: Sign
-  t: Value
-  isPrincipal: boolean
-  connection?: Connection
-}
+  A net is an undirected graph where each edge
+  must be connected through ports.
 
-export type PortRecord = Record<string, PortEntry>
+  We implement a net like adjacency list,
+  but the list of nodes is replaced by a record of ports.
+
+*/
+
+export type Net = {
+  edges: Array<Edge>
+  activeEdges: Array<Edge>
+  nodeEntries: Map<string, NodeEntry>
+}
 
 export type NodeEntry = {
   id: string
@@ -25,8 +26,17 @@ export type NodeEntry = {
   ports: PortRecord
 }
 
-export type Net = {
-  edges: Array<Edge>
-  activeEdges: Array<Edge>
-  nodeEntries: Map<string, NodeEntry>
+export type PortRecord = Record<string, PortEntry>
+
+export type PortEntry = {
+  name: string
+  sign: Sign
+  t: Value
+  isPrincipal: boolean
+  connection?: Connection
+}
+
+export type Connection = {
+  edge: Edge
+  port: Port
 }