note about createReport

cicada-lang · Aug 5, 2023 · b65c2ec · b65c2ec
1 parent 21359b8
commit b65c2ec
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lang/errors/createReport.ts b/src/lang/errors/createReport.ts
@@ -1,6 +1,9 @@
 import { Report, ReportEntry } from "./Report"
 
 export function createReport(error: unknown, entry: ReportEntry): Report {
+  // NOTE We put the most recent report entry at the end,
+  // because the end is closer to user's terminal output.
+
   if (error instanceof Report) {
     error.entries.push(entry)
     return error